shared-users

List Users

List all users in the caller’s organization with pagination.

Open to all staff roles (admin, office-admin, office-employee) — this is the crew management table that operations staff need daily. Role assignment (PATCH //role) is still admin-only below.

role is the locally-cached WorkOS membership role, kept fresh by the membership webhook handlers and the hourly reconciliation worker. It’s safe for filtering and display; authz decisions still go through the JWT.

GET

api

shared

users

List Users

curl --request GET \
  --url https://api.example.com/api/v1/shared/users \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "role": "<string>",
      "state": "<string>",
      "lastLogin": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

role

string | null

Filter by cached role

state

string | null

Filter by state

limit

integer

default:10

Items per page

Required range: 1 <= x <= 1000

cursor

string | null

Pagination cursor

string | null

Search term

Maximum string length: 200

include_count

boolean

default:false

Include total count

Response

Successful Response

items

UserDetailDTO · object[]

required

Show child attributes

nextCursor

string | null

hasMore

boolean

default:false

totalCount

integer | null

Get UserGet a specific user by ID. Open to all staff roles. User is loaded org-scoped via `load_user` — a cross-org request returns 404.

List Users

curl --request GET \
  --url https://api.example.com/api/v1/shared/users \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "role": "<string>",
      "state": "<string>",
      "lastLogin": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}