List Members

GET /members

List Members

List organization members. Pagination is opt-in: omit page_size to get the full member list in one response. page is only meaningful together with page_size and is rejected without it.

Parameters

• q (query, string, optional): Case-insensitive substring search over member email and display name.

• page (query, integer, optional): 1-based page number. Requires page_size on the same request.

• page_size (query, integer, optional): Page size. Values above 200 are clamped to 200. Omit to return the full list.

Responses

• 200: OK

• data (array, required): Members visible to the authenticated organization.

• data[].id (string, required): Organization membership ID. This is what caller API key ownership references, and what usage records carry as their member attribution.

• data[].user_id (string, required): User ID of the member. This is the identifier referenced by team membership and by this member's own routes (/members/{user_id}); caller API key ownership references the membership id above instead.

• data[].email (string, required): Member email address (unique per user).

• data[].display_name (string, required): Human-readable member name.

• data[].role (string, required): Built-in (owner, admin, or member) or custom organization role. Members created via POST /members are always assigned member initially.

• data[].status (string, optional): Lifecycle state. A deactivated member keeps its usage history, but every caller API key it owns is disabled. SCIM directory sync sets this when the person is deprovisioned in the identity provider.

• data[].provisioned_by (string, optional): How the membership was created. scim memberships are managed by the organization's identity provider through the SCIM 2.0 endpoints and cannot be edited in the dashboard.

• data[].created_at (string, required): Time when the membership was created.

• total (integer, required): Total number of matching members across all pages.

• page (integer, required): Current 1-based page (1 when unpaged).

• page_size (integer, required): Effective page size (0 when unpaged).

• owner_count (integer, required): Number of members with the owner role.

• 400: Request body or parameters failed validation.

• error (object, required): Error details.

• error.code (string, required): Machine-readable identifier. Examples: UNAUTHENTICATED, INVALID_REQUEST, MASTER_KEY_UNSET, INTERNAL.

• error.message (string, required): Human-readable explanation; safe to surface to operators.

• 401: Missing or invalid bearer. Response fields (application/json): identical to GET /members, response 400 above.

cURL

curl -X GET '$AISIX_CP/members' -H 'Authorization: Bearer $AISIX_TOKEN'