Skip to main content
GET
List workspace members

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

Sajn-Version
enum<string>

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.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

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

limit
integer
default:25

Maximum number of items to return, from 1 to 100. Default: 25.

Required range: 1 <= x <= 100
cursor
string

The nextCursor from the previous response, to get the next page. Keep the other parameters unchanged.

Required string length: 1 - 2048
include
enum<string>[]

total adds the number of items that match the filters. Counting takes time, so ask for it only when you need it.

Available options:
total
status
enum<string>

Filter by activity. A member is ACTIVE once they have signed in at least once. Omit for both.

Available options:
ACTIVE,
INACTIVE
roleId
string[]

Only return members with one of these workspace roles. Comma-separated or repeated.

permission
enum<string>

Only return members whose role grants this permission, directly or through ADMINISTRATOR. For example, APPROVE_DOCUMENT lists the members who can approve documents.

Available options:
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
query
string

Free-text search across member name and email

orderBy
enum<string>
default:joinedAt

The field to sort by. Default: joinedAt.

Available options:
joinedAt,
lastActiveAt,
name
orderDirection
enum<string>
default:desc

The sort direction. Default: desc.

Available options:
asc,
desc

Response

Paginated workspace members

Paginated workspace members

data
object[]
required
hasMore
boolean
required

True if more items follow this page.

nextCursor
string | null
required

Pass this as cursor to get the next page. Null on the last page.

total
integer

The number of items that match the filters. Present only with include=total.

Required range: -9007199254740991 <= x <= 9007199254740991