Users
The people in a workspace: their membership, the roles they hold, and the record of both.
List users
Everyone holding a membership in the calling workspace. Each row carries both the user account and that membership, so roles and last login come back with it. external_user marks an account that belongs to another workspace and is only a guest in this one.
query Parameters
cursor^[A-Za-z0-9_-]+$external_userlimitmemb_activememb_rolesoffsetsort^-?[a-z0-9_]+$usr_activeusr_emailusr_idusr_nameHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List users › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Add a user
Adds a person to the workspace and sends them an invitation. A user already known to the platform is attached to this workspace rather than created again.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Add a user › Request Body
usr_name_firstusr_name_lastusr_emailusr_activeusr_passAdd a user › Responses
Success
Get a user
Returns one member with the roles they hold in this workspace.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a user › Responses
Success
usr_idusr_emailusr_createdusr_activeusr_name_firstusr_name_lastusr_langusr_themeusr_nameexternal_usermemb_picturememb_activememb_rolesmemb_permissionsmemb_settingsmemb_last_loginmemb_attrUpdate a user
This is where a user's roles are set, and so what they may do.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a user › Request Body optional
usr_name_firstusr_name_lastusr_emailusr_activeUpdate a user › Responses
Success
usr_idusr_emailusr_createdusr_activeusr_name_firstusr_name_lastusr_langusr_themeusr_nameexternal_usermemb_picturememb_activememb_rolesmemb_permissionsmemb_settingsmemb_last_loginmemb_attrList user history
Every recorded change, newest first, each as a per-field {from, to} changeset.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List user history › Responses
Success
history_idhistory_timestamphistory_userhistory_opThe kind of change — insert, update or delete.
One entry per field that changed, keyed by column name.
history_refWhat the writer noted about the change rather than the columns: the action that made it, or the reason it was made.
Send a password reset
Emails the user a reset link. No password is set or returned here.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Send a password reset › Responses
Success