Skip to main content
POST
/
workspaces
/
{workspace_id}
/
invitations
Invite user to workspace
curl --request POST \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "newuser@example.com"
  ],
  "role": "owner"
}
'
{
  "status": "success",
  "data": {
    "id": 90967,
    "email": "newuser@example.com",
    "created_at": "2023-09-22T20:25:45.185Z",
    "created_by_id": 13,
    "claimed_by_id": 11,
    "role": "owner"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authorization using your Personal Access Token. Generate a new PAT on your user settings page.

Path Parameters

​
workspace_id
integer
required

ID of the workspace

Body

application/json
​
emails
string[]

Email addresses of the invitees.

Example:
["newuser@example.com"]
​
role
enum<string>

Role assigned to the invitee.

Available options:
owner,
editor,
operator,
viewer
Example:

"owner"

Response

Successfully created workspace invitation.

​
status
enum<string>
required

The outcome of the creation request

Available options:
success
Example:

"success"

​
data
object
required