Platform API reference

Platform API · Workspaces

get/v1/workspaces/{workspace_slug}/invitesAuth

List workspace invites, newest first. 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

data*array

One page of invites.

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}/invites
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "code": "string",
      "email": "user@example.com",
      "role_id": "00000000-0000-0000-0000-000000000000",
      "max_uses": 0,
      "use_count": 0,
      "expires_at": "2026-01-01T00:00:00.000Z",
      "revoked_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "created_by": "00000000-0000-0000-0000-000000000000",
      "role_name": "string"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}