Role

Some API endpoints (e.g. Prediction and Draft), are protected by roles. To be able to access those endpoints, Users and Clients need to have the corresponding roles assigned to them.

Get assignable roles

API Request

GET https://api.bespokify.com/v2/roles

Example response

[
  {
    "composite": false,
    "name": "predict"
  },
  {
    "composite": false,
    "name": "drafts"
  }
]

Roles can be assigned to users and clients using the User API and the Client API.

If a role is composite, it has one or more roles associated with it. When it is assigned to a user/client, that user/client also gains the associated roles.