POST
/
users
Invite user
curl --request POST \
  --url https://api.steuerboard.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --data '{
  "email": "frida@example.com",
  "role": "client_admin",
  "workspaceIds": [
    "cmf41ajzv003706un4i99q19z"
  ]
}'
{
  "id": "cmf41ajzv003706un4i99q1a0",
  "createdAt": "2024-05-14T08:30:00Z",
  "email": "frida@example.com",
  "firstName": "Frida",
  "lastName": "Meyer",
  "roles": [
    "client_admin"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Headers

​
x-client-id
string<cuid>
required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"

Body

application/json

User invite

​
email
string<email>
required

Email address that should receive the invitation.

Example:

"frida@example.com"

​
role
enum<string>
required

Role to assign to the invited user.

Available options:
client_admin,
client_user
Example:

"client_admin"

​
workspaceIds
string<cuid>[]

Optional list of workspace IDs the user should join immediately.

Workspace identifier the user should be granted access to.

Response

User invited

​
id
string<cuid>
required

Identifier of the client user.

Example:

"cmf41ajzv003706un4i99q1a0"

​
createdAt
string<date-time>
required

The date and time when the client user record was created. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2024-05-14T08:30:00Z"

​
email
string<email>
required

Email address of the client user.

Example:

"frida@example.com"

​
firstName
string | null
required

First name of the client user, if provided.

Example:

"Frida"

​
lastName
string | null
required

Last name of the client user, if provided.

Example:

"Meyer"

​
roles
string[]
required

List of role names assigned to the user.

Role name assigned to the user.