Meet the new Scripe, live on October 7.Register

OpenAPI reference · Workspace

List team members

GET/team

The active workspace's team members: display name, email, org role, avatar, join date, and per-member project assignments. Reads at most 100 members — truncated: true with a higher totalCount means the workspace has more. Project references are limited to the projects the caller can reach itself and to 25 distinct projects — projectsTruncated: true means refs beyond the cap were omitted; page the full set via GET /projects. Credentials and tokens never appear in this response. Requires the workspace:read scope.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

    The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Header parameters

  • Scripe-Api-Versionstring

    Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Responses

  • 200

    Team member list.

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request GET \
  --url 'https://api.scripe.io/v1/team' \
  --header 'Authorization: Bearer <token>'

Example response (200)

json
{
  "data": [
    {
      "userId": "user_2abcDEF",
      "name": "string",
      "email": "string",
      "role": "org:admin",
      "roleLabel": "Admin",
      "avatarUrl": "string",
      "joinedAt": "2026-08-10T09:00:00Z",
      "projects": [
        {
          "id": "proj_a1b2c3d4e5f6g7h8",
          "name": "string"
        }
      ]
    }
  ],
  "totalCount": 0,
  "truncated": true,
  "projectsTruncated": true
}