Skip to main content
POST
/
invites
Create an invite
curl --request POST \
  --url https://app.tryordinal.com/api/v1/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "newuser@example.com"
}
'
{
  "invite": {
    "id": "550e8400-e29b-41d4-a716-446655440500",
    "email": "newuser@example.com",
    "createdAt": "2026-01-15T10:00:00.000Z"
  },
  "sentEmail": true
}

Authorizations

Authorization
string
header
required

API key authentication. Generate an API key from your workspace settings.

Body

application/json
email
string<email>
required

The email address of the user to invite

Response

Invite created or user added to workspace

invite
object

The created invite, or null if the user was added directly to the workspace

sentEmail
boolean

Whether an invite email was sent