Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
workspace

Get Workspace Members

Gets a list of all members of the workspace, including locked members. Service accounts are excluded. Requires the workspace_members_read permission.

get/v1/workspace/members

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

user_idstring required

The user ID of the workspace member.

emailstring required

The email address of the workspace member.

first_namestring nullable required

The first name of the workspace member, if available.

seat_type'workspace_admin' | 'workspace_member' | 'workspace_lite_member' required

Seat types for workspace members.

is_ownerboolean required

Whether the member is the workspace owner.

is_lockedboolean required

Whether the member's account is locked in this workspace.