GET
/
roles
curl --request GET \
  --url https://api.beyondwords.io/v1/roles \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "key": "owner",
    "name": "Owner",
    "organization_id": 1,
    "permissions": {
      "content_view": {
        "enabled": true
      },
      "content_create": {
        "enabled": false
      }
    },
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 2,
    "key": "admin",
    "name": "Admin",
    "organization_id": 1,
    "permissions": {
      "content_view": {
        "enabled": false
      },
      "content_create": {
        "enabled": false
      }
    },
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
pagination[limit]
integer

'limit' sets the number of results to return in each page.

​
pagination[offset]
integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

Response

200
application/json
OK
​
id
integer
​
key
string
​
name
string
​
organization_id
integer
​
permissions
object | null
​
members_count
integer
​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)