Skip to Content
API reference

Organization members

Read the member directory for the organization associated with your API key.

The member API provides read-only access to the key's organization directory. Both endpoints require the X-API-Key header. They cannot create or remove members, change roles, or send invitations.

List members

GET /api/v1/members
curl --fail-with-body 'https://your-app.example/api/v1/members?limit=25' \
  -H "X-API-Key: $API_KEY"
Query parameterTypeDescription
limitinteger, optionalPage size from 1 to 100. Defaults to 25.
cursorUUID string, optionalnextCursor from the preceding response. Omit for the first page.

Members are ordered by membership ID in ascending order. Continue with the returned nextCursor until it is null. An empty directory returns items: [] and nextCursor: null. Invalid, repeated, or unsupported query parameters return 400.

200 OK
{
	"items": [
		{
			"id": "e052cbd7-3604-48f1-b8dd-bbb2adff11e4",
			"role": "member",
			"createdAt": "2026-11-03T12:00:00.000Z",
			"user": {
				"id": "8a731396-0256-4496-8d86-5455dc3131b1",
				"name": "Jane Smith",
				"email": "[email protected]",
				"image": null
			}
		}
	],
	"nextCursor": null
}

Get a member

GET /api/v1/members/{memberId}

Use the membership id from the list response, which is distinct from user.id.

curl --fail-with-body \
  https://your-app.example/api/v1/members/e052cbd7-3604-48f1-b8dd-bbb2adff11e4 \
  -H "X-API-Key: $API_KEY"

A successful 200 response is a single member object, with the same fields as an entry in items above. A member that does not exist, was removed, or belongs to another organization returns 404 with { "error": "Member not found" }.

Member fields

FieldTypeDescription
idUUID stringOrganization membership ID
roleowner, admin, or memberRole in this organization
createdAtISO 8601 date-time stringWhen the membership was created
user.idUUID stringUser account ID
user.namestringDisplay name
user.emailemail stringMember's email address
user.imagestring or nullProfile image value, when set

The directory includes owners, admins, and ordinary members. It excludes pending invitations, sessions, credentials, platform roles, security settings, and memberships in other organizations. Responses use Cache-Control: no-store.

Errors

StatusMeaning
400Invalid pagination parameters or malformed membership UUID
401Key missing, invalid, expired, or revoked
404Member not found in the key's organization (single-member endpoint)
405Unsupported method, including POST, PATCH, PUT, and DELETE
500Internal server error

See Errors and troubleshooting. Responses to unsupported methods may use a different error format.

On this page