Skip to main content
GET
Get a workspace role
You’re viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To see the current version, select 2026-10 in the menu at the top of the sidebar. To move your integration, see Upgrading to 2026-10.

Authorizations

Authorization
string
header
required

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

Scopes

roles:read

Tillgång till att läsa arbetsytans roller och behörigheter

Headers

authorization
string
required

Bearer token for API authentication

Path Parameters

id
string
required

Response

Workspace role

Workspace role

id
string
required

Immutable role identifier — pass this to addMember

name
string
required

Human-readable role name. Editable by org admins.

isDefault
boolean
required

True for the role that newly-invited members get by default

permissions
enum<string>[]
required

Permission keys granted by this role

A workspace permission key, e.g. "READ_DOCUMENT" or "SEND_DOCUMENT"

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
memberCount
number
required

Number of workspace members currently assigned this role

createdAt
any
required
updatedAt
any
required