List workspace members
Returns the members of the workspace bound to the current API token, paginated and filterable by activity, role, permission and free-text search. To list the members who can approve documents, pass permission=APPROVE_DOCUMENT. Address an individual member by their id, which is their user ID.
Permission required: MANAGE_WORKSPACE_MEMBERS on the workspace.
Authorizations
Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.
Headers
API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.
2026-09, 2026-10 ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
Query Parameters
Maximum number of items to return, from 1 to 100. Default: 25.
1 <= x <= 100The nextCursor from the previous response, to get the next page. Keep the other parameters unchanged.
1 - 2048total adds the number of items that match the filters. Counting takes time, so ask for it only when you need it.
total Filter by activity. A member is ACTIVE once they have signed in at least once. Omit for both.
ACTIVE, INACTIVE Only return members with one of these workspace roles. Comma-separated or repeated.
Only return members whose role grants this permission, directly or through ADMINISTRATOR. For example, APPROVE_DOCUMENT lists the members who can approve documents.
READ_DOCUMENT, CREATE_DOCUMENT, EDIT_DOCUMENT, DELETE_DOCUMENT, SEND_DOCUMENT, APPROVE_DOCUMENT, EDIT_AFTER_SEND, SEND_WITHOUT_APPROVAL, WITHDRAW_DOCUMENT, VIEW_SAJN_ID, MANAGE_SAJN_ID, VIEW_PRIVATE_DOCUMENT, READ_FILE, CREATE_FILE, DELETE_FILE, CHANGE_DOCUMENT_VISIBILITY, READ_CONTACT, CREATE_CONTACT, DELETE_CONTACT, MANAGE_WORKSPACE_MEMBERS, MANAGE_WORKSPACE_ROLES, MANAGE_WORKSPACE_SETTINGS, MANAGE_FORM, DELETE_FORM, READ_FORM_SUBMISSIONS, CREATE_TEMPLATE, UPDATE_TEMPLATE, DELETE_TEMPLATE, RESTORE_TEMPLATE, PERMANENTLY_DELETE_TEMPLATE, VIEW_PRIVATE_TEMPLATE, CHANGE_TEMPLATE_VISIBILITY, CREATE_TAG, UPDATE_TAG, DELETE_TAG, CREATE_CUSTOM_FIELD, UPDATE_CUSTOM_FIELD, DELETE_CUSTOM_FIELD, UPDATE_FILE, UPDATE_CONTACT, MANAGE_AI_SETTINGS, USE_AI_CHAT, USE_AI_DOCUMENT_GENERATION, USE_AI_TEXT_ENHANCEMENT, READ_DOCUMENT_AUDIT_LOG, PERMANENTLY_DELETE_DOCUMENT, RESTORE_DOCUMENT, FORCE_COMPLETE_DOCUMENT, READ_COMMENT, CREATE_COMMENT, UPDATE_COMMENT, DELETE_COMMENT, IMPORT_CONTACTS, EXPORT_CONTACTS, MANAGE_CONTACT_NOTES, LOCK_TEMPLATE, READ_REPORT, CREATE_REPORT, UPDATE_REPORT, DELETE_REPORT, CREATE_BULK_SEND, CREATE_PRODUCT, UPDATE_PRODUCT, DELETE_PRODUCT, MANAGE_API_TOKENS, MANAGE_WEBHOOKS, AUTHORIZE_OAUTH_APP, MANAGE_DEVELOPER, CREATE_FOLDER, UPDATE_FOLDER, DELETE_FOLDER, LOCK_SECTION, ADMINISTRATOR Free-text search across member name and email
The field to sort by. Default: joinedAt.
joinedAt, lastActiveAt, name The sort direction. Default: desc.
asc, desc Response
Paginated workspace members
Paginated workspace members
True if more items follow this page.
Pass this as cursor to get the next page. Null on the last page.
The number of items that match the filters. Present only with include=total.
-9007199254740991 <= x <= 9007199254740991
