Users
View as MarkdownUsers are people with access to the workspace. Use these endpoints to look up accounts, invite an existing user, or deactivate an account.
A user record contains account details, sign-up state, and workspace preferences.
Attributes
idinteger- Identifier assigned by the API.
firstnamestring or null- Given name.
surnamestring or null- Family name.
emailstring- Email address associated with the account.
phonestring or null- Contact phone.
is_activeinteger- 1 if active, 0 if inactive.
is_ownerinteger- 1 if this user owns the workspace, otherwise 0.
signup_process_completedinteger- 1 if the user completed sign-up, otherwise 0.
invited_atinteger or null- Latest invitation time as Unix seconds.
localestring or null- Preferred display language.
timezonestring or null- Preferred IANA time zone.
deleted_atinteger or null- Deactivation timestamp as Unix seconds.
tscinteger- Creation time as a Unix timestamp in seconds.
tsuinteger- Last update time as a Unix timestamp in seconds.
/api/v1/usersLists active or deactivated workspace users.
Permissions
Send your API key in X-API-Key. Required permissions are Users → Read.
Query parameters
statusstring- Use active or deactivated. Defaults to active.
qstring- Search given name, family name, or email.
lengthinteger- Number of records to return.
startinteger- Zero-based offset.
drawstring- Optional request marker echoed in the response.
sortstring- Sort by id, firstname, surname, email, phone, roles, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring- Direction for unprefixed sort fields. Use asc or desc.
Returns
Returns records in data, the counts before and after text search, and the echoed draw marker.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
422- The status filter must be active or deactivated.
/api/v1/users/{id}Returns one user by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Users → Read.
Path parameters
idintegerRequired- ID of the user.
Returns
Returns the user in data.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
/api/v1/users/{id}/inviteEmails an invitation to an existing user who still needs to complete sign-up.
Permissions
Send your API key in X-API-Key. Required permissions are Users → Write.
Path parameters
idintegerRequired- ID of the user.
Resending generates a new invitation link. The recipient completes sign-up using the emailed link.
Returns
Returns invited: true after the email is sent.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
400- The user already completed sign-up, or the invitation could not be sent.
404- The requested record was not found.
/api/v1/users/{id}Deactivates the user and revokes their workspace invitation.
Permissions
Send your API key in X-API-Key. Required permissions are Users → Write.
Path parameters
idintegerRequired- ID of the user.
Returns
Returns confirmation that the user was deactivated.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
400- The account could not be deactivated.
404- The requested record was not found.