Platform API reference

Platform API · Workspace-Roles

get/v1/workspaces/{workspace_slug}/rolesAuth

List roles in a workspace. System roles first, then alphabetical. 20/page (max 100), cursor-paginated.

Path parameters

workspace_slug*string

Slug of the workspace. Platform routes name the workspace by slug, positionally in the SDK (`platform.workspaces.retrieve("acme")`); the product APIs bind `workspace_id` instead.

Query parameters

limitinteger

Page size. Defaults to 20, clamped to 100.

cursorstring

Opaque `next_cursor` from the previous page.

Response · 200 Page of roles with `next_cursor` and `has_more`.

data*array

One page of roles.

pagination*object
next_cursor*string

Pass as `cursor` to get the next page; `null` on the last page.

Example: null

has_more*boolean

Whether another page follows this one.

Example: false

Example

Request

GET https://api.platform-auth.productcraft.co/v1/workspaces/{workspace_slug}/roles
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "description": "string",
      "is_system": false,
      "policy": [
        {
          "effect": "allow",
          "actions": [
            "social.read",
            "social.list"
          ],
          "resources": [
            "*"
          ]
        }
      ],
      "policy_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}