List staff with access to the workspace

Minimum role: ADMIN. Active workspace via the X-Workspace-Id header. With ?workspaceIds=, cursor pagination is still per user: limit counts people, not rows.

GET/staff

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters

limitinteger

1-100, default 20

default: 20

cursorstring

workspaceIdsstring

Comma-separated workspace ids (max. 25). Returns the staff of all of them in a single call, with each row tagged with workspaceId/workspaceName (one row per person and workspace). Always intersected with the workspaces the credential can already manage: it never widens its scope. Without the parameter, the workspace from the X-Workspace-Id header is listed.

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses

200

dataStaffUser[]required

Show properties

Array of StaffUser

idstringrequired

namestringrequired

emailstringrequired

rolestringrequired

Allowed:SUPER_ADMINADMINSTAFFVIEWERMINCULTURA

organizationIdstring | nullrequired

Show properties

Any of:

string

string

null

null

workspaceIdstring

workspaceNamestring

createdAtstringrequired

pagePagerequired

Show properties

nextCursorstring | nullrequired

Show properties

Any of:

string

string

null

null

hasMorebooleanrequired

totalinteger

min -9007199254740991 · max 9007199254740991

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

limitquery1-100, default 20cursorqueryworkspaceIdsqueryComma-separated workspace ids (max. 25). Returns the staff of all of them in a single call, with each row tagged with `workspaceId`/`workspaceName` (one row per person and workspace). Always intersected with the workspaces the credential can already manage: it never widens its scope. Without the parameter, the workspace from the `X-Workspace-Id` header is listed.X-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/staff' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/staff", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/staff",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "role": "SUPER_ADMIN",
      "organizationId": "string",
      "workspaceId": "string",
      "workspaceName": "string",
      "createdAt": "string"
    }
  ],
  "page": {
    "nextCursor": "string",
    "hasMore": true,
    "total": -9007199254740991
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}