Skip to content
MediuxDocs

Protected API

The Protected API lets your app act for one Mediux user, within the permissions they approved. Routes live on https://api.mediux.io under /account, /notifications and /relationships.

  1. Register your app and connect a user.
  2. Call from your server or native app with Authorization: Bearer ACCESS_TOKEN. Never send Mediux cookies.
  3. Keep tokens out of logs, source control and web pages.

Each request checks the connection, the granted permission and that the user owns what you touch. You always act as the user who approved the token: an ID in the request never changes whose data you change.

Apps can’t publish or change artwork, Sets, Boxsets or Loadouts, delete Lists, Like anything or manage the account. Owners do those on mediux.io.

Responses are Cache-Control: private, no-store, and errors use the shared error format. Send only the fields you change; omitted fields stay as they are.

AreaRoutesPermission
IdentityGET /accountAny
RelationshipsFollows and hides belowrelationships:read or relationships:manage
Lists/account/lists, see Read and edit Listslists:read or lists:write
NotificationsGET /notifications, POST /notifications/readnotifications:read

GET /notifications lists the user’s notifications, newest first, paged with ?after= and ?limit= (see protected lists). POST /notifications/read marks them read: send { "ids": [...] } with 1 to 100 IDs, or { "all": true }. It answers { "data": { "markedRead": 3 } }. IDs that aren’t the user’s change nothing.

Relationships

MethodPathOperationScope
GET/relationshipsList relationshipsrelationships:read
PUT/relationships/{username}Follow or hide a Userrelationships:manage
DELETE/relationships/{username}Clear a relationshiprelationships:manage

Identity

MethodPathOperationScope
GET/accountGet the connected Userany App Permission

Your Lists

MethodPathOperationScope
GET/account/listsList your Listslists:read
POST/account/listsCreate a Listlists:write
GET/account/lists/membershipFind your Lists holding a titlelists:read
GET/account/lists/{id}Get one of your Listslists:read
PATCH/account/lists/{id}Edit one of your Listslists:write
GET/account/lists/{id}/titles/{family}/{entity}Get a title in one of your Listslists:read
POST/account/lists/{id}/titlesAdd titles to a Listlists:write
POST/account/lists/{id}/titles/removeRemove titles from a Listlists:write
POST/account/lists/{id}/assetsAdd Assets to an Asset Listlists:write
POST/account/lists/{id}/assets/removeRemove Assets from an Asset Listlists:write
PUT/account/lists/{id}/subscriptionSubscribe to or leave a Public Listlists:write

Notifications

MethodPathOperationScope
GET/notificationsList your Notificationsnotifications:read
POST/notifications/readMark Notifications readnotifications:read