Skip to content

List members

The members.list operation: GET /api/v1/members in the REST API and the members_list tool in the MCP server.

GET/api/v1/members

Lists the organization's memberships, newest first: who (with their email address and name), which role, at which scope (the whole organization, one legal entity or one brand) and whether they have live-mode access. A person can hold several memberships, one per scope. Filter with userId.

Needs members:read (organization owners and admins, or an org management key).

At a glance

  • REST: GET /api/v1/members
  • MCP tool: members_list
  • Operation ID: members.list
  • Scope: Organization
  • Permission: members:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: API key with the members:read scope
  • Since: M1

Request

Query parameters

FieldTypeRequiredDescription
userIdusr_… IDNo
limitinteger (1 to 100)No
starting_aftermem_… IDNo

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
object"list"
dataarray of object
data[].idmem_… ID
data[].object"membership"
data[].orgIdorg_… ID
data[].userIdusr_… ID
data[].roleone of org_owner, org_admin, billing_admin, finance, tax_manager, support, developer, viewer
data[].scopeobject
data[].livemodeAccessboolean
data[].invitedByusr_… ID or null
data[].userobject or null
data[].createdAtdate-time
data[].updatedAtdate-time
has_moreboolean
next_cursormem_… ID or null

Examples

An owner and a brand developer

HTTP
GET /api/v1/members
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "mem_01m4tx5nj8emwbyf7y9vcf47x6",
      "object": "membership",
      "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
      "userId": "usr_01m4tx5nj8emwbyf7y9vcf47xb",
      "role": "developer",
      "scope": {
        "type": "brand",
        "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4"
      },
      "livemodeAccess": false,
      "invitedBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa",
      "user": {
        "email": "dev@acme.example",
        "name": "Dana Developer"
      },
      "createdAt": "2026-10-13T12:00:00.000Z",
      "updatedAt": "2026-10-13T12:00:00.000Z"
    },
    {
      "id": "mem_01m4tx5nj8emwbyf7y9vcf47x7",
      "object": "membership",
      "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
      "userId": "usr_01m4tx5nj8emwbyf7y9vcf47xa",
      "role": "org_owner",
      "scope": {
        "type": "org"
      },
      "livemodeAccess": true,
      "invitedBy": null,
      "user": {
        "email": "owner@acme.example",
        "name": "Olivia Owner"
      },
      "createdAt": "2026-10-13T12:00:00.000Z",
      "updatedAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A filter or pagination value is malformed.Fix the fields listed in details.issues and send the request again.
permission_denied403You can't see this organization's members.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, resource_not_found, dry_run_not_supported, rate_limited, internal_error.