Skip to content

Team

List members

Returns the workspace members as a JSON array. Each item has two ids: id is the membership (used by the member endpoints) and user_id is the person (used as assignee_id on conversations).

GET/api/v1/members
  • Bearer API key
  • Scope: read or write
  • or app session
  • Workspace: X-Tenant-ID (optional with a key)

Headers

  • Authorizationstringrequired

    Your API key as Bearer <key>. The word Bearer and the space are case-sensitive. Browser clients signed in to the app use the session cookie instead.

    Constraints
    Keys start with pk_live_ and are 56 characters long.
    Example
    Bearer pk_live_…
  • X-Tenant-IDuuidoptional

    Workspace id. Optional with an API key (a key always acts in its own workspace); if you send it, it must match the key’s workspace. Required with a session cookie. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • []array<Member>

    Workspace members.

    Show child attributesHide child attributes5
    • iduuid

      Membership id. Use it in /api/v1/members/{id}.

    • user_iduuid

      User id. Use this one as assignee_id when assigning conversations.

    • emailstring

      Email address.

    • namestring

      Display name.

    • roleenum

      owner, admin or agent.

Status codes

  • 200OK. An array of members (not wrapped in an object).
  • 401Unauthorized. The API key is unknown, revoked or expired (invalid or expired API key), or there is no key and no signed-in session (unauthorized).
  • 402Payment required. Only when subscriptions are enforced and the workspace has no active subscription. The body includes code: "payment_required".
  • 403Forbidden. The X-Tenant-ID header or tenant query does not match the API key’s workspace (API key belongs to a different workspace), or a signed-in user is not a member of the workspace (forbidden).
  • 500Server error. The members could not be loaded.