Skip to main content
POST
cURL
Puts one person in the workspace the API key belongs to, with a workspace role. This is the endpoint for workspace admins: it never needs organization-level rights, and what it does depends on whether the person is already in the organization. An invitation issued here still belongs to the organization: the invitee joins the organization as a member and this workspace at role. To invite someone with a different organization role, or into several workspaces at once, use Invite User.

Request body

Response

Example

Authentication

This endpoint requires an API key in the x-api-key header. The workspace is always the key’s own workspace. Only a workspace admin can invite to a workspace. For an API key, that is read from the creator’s role in the key’s workspace. Organization owners and admins are admins of every workspace, so their keys qualify too.
On the Free plan every member of the organization is an owner, so a workspace has no member role: send role: "admin". A new invitee joins the organization as an owner.

Errors

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Body

Someone to invite to your current workspace, with their role in it.

email
string<email>
required
role
enum<string>
required

The person's role in this workspace.

  • admin - Admin
  • member - Member
Available options:
admin,
member
first_name
string
default:""
Maximum string length: 150
last_name
string
default:""
Maximum string length: 150

Response

What inviting someone to your current workspace did.

status
enum<string>
required

invited: invited to the organization from this workspace, waiting in it until they accept. resent: already invited, their pending invitation was re-sent from this workspace. associated: already active in the organization, only added to this workspace; nothing was sent.

  • invited - invited
  • resent - resent
  • associated - associated
Available options:
invited,
resent,
associated
user
object
required

The person, as the workspace's users list them.

invitation
object | null
required

The invitation sent or re-sent; null when nothing was sent.