Members

Every endpoint on this page requires members:read.

GET /v1/members

Returns a paged member directory.

Query parameters

Parameter	Type	Notes
team_code	string	Optional team-code filter
team_id	string, repeatable	Optional team-id filter
role	string, repeatable	owner, admin, member, guest
status	string, repeatable	invited, active, suspended, removed
query	string	Optional free-text filter
cursor	string	Optional cursor
page_size	integer	Optional page size
sort	string	display_name, role, or status
direction	string	asc, ascending, desc, or descending

Example

curl "$API_BASE_URL/v1/members?team_code=PLAT&role=admin&status=active&sort=display_name&direction=asc" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response 200 OK:

{
  "results": [
    {
      "id": "member_01EXAMPLE",
      "userAccountId": "usr_01EXAMPLE",
      "displayName": "Alex Morgan",
      "avatarUrl": "https://cdn.example.com/avatars/alex.png",
      "emailAddress": "alex@example.com",
      "principalKind": 0,
      "role": 2,
      "status": 2,
      "teamIds": [
        "team_platform"
      ],
      "teamNames": [
        "Platform"
      ]
    }
  ],
  "pagination": {
    "pageSize": 100,
    "cursor": "",
    "nextCursor": "",
    "hasMore": false,
    "returnedCount": 1,
    "totalCount": 1
  }
}

GET /v1/members/{memberId}

Returns one member by member ID.

curl "$API_BASE_URL/v1/members/member_01EXAMPLE" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response 200 OK:

{
  "id": "member_01EXAMPLE",
  "userAccountId": "usr_01EXAMPLE",
  "displayName": "Alex Morgan",
  "avatarUrl": "https://cdn.example.com/avatars/alex.png",
  "emailAddress": "alex@example.com",
  "principalKind": 0,
  "role": 2,
  "status": 2,
  "teamIds": [
    "team_platform",
    "team_product"
  ],
  "teamNames": [
    "Platform",
    "Product"
  ]
}

Error notes

• Invalid team filters return 400 invalid_request
• Unknown members return 404 not_found