1. Docs
  2. API Reference
  3. List an organization's members

List an organization's members

GET/api/v1/organizations/{id}/members

Lists the organization's members: each row is the member's identity, their single role in this organization, effective dates, and when they joined. Paginated; q searches name and email. Requires the rbac.view_assignments permission at the organization.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

qstring Optional

Search term

max length 200

sort_bystring Optional

Column to sort by. Allowed values depend on the endpoint.

orderenum Optional

Sort direction

one of "asc" · "desc"

role_idstring · uuid Optional

Only members holding this role

statusenum Optional

Filter by the membership's effective window: active now, scheduled to start, or already expired

one of "active" · "scheduled" · "expired"

Responses

application/json

  • itemsOrganizationMemberResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1–100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

OrganizationMemberResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/organizations/value/members?page=0&take=0&q=value&sort_by=value&order=asc&role_id=value&status=active" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "id": "string",
      "identity": {
        "id": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string"
      },
      "role": {
        "id": "string",
        "name": "string"
      },
      "effective_from": "2026-04-20T12:00:00.000Z",
      "effective_to": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
GETList organizations
POSTCreate an organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
DELETERevoke an organization invitation
 Was this page helpful?

Tell us how we can improve this guide.

Canopy