Skip to content
Management API Reference

List members of an organization

get/v2/organizations/{slug}/members

Returns a cursor-paginated list of organization members including their roles and project-scoped permissions.

OAuth scopes

  • organizations:read

The fine-grained token must include the following permissions to access this endpoint:

  • members_read

Path parameters

  • slug
    Required
    string

    Organization slug

Query parameters

  • page
    Optional
    object
  • filter
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
  "data": [
    {
      "type": "organization_member",
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "attributes": {
        "username": "lorem",
        "primary_email": "lorem",
        "mfa_enabled": true,
        "is_sso_user": true,
        "avatar_url": "lorem",
        "roles": [
          {
            "name": "developer",
            "scope": "organization",
            "projects": [
              {
                "ref": "lorem",
                "name": "lorem"
              }
            ]
          }
        ]
      }
    }
  ],
  "links": {
    "first": "/v2/organizations/my-org/members?page[size]=10",
    "prev": "/v2/organizations/my-org/members?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
    "next": "/v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
    "last": "/v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
  }
}