Create an invite

Invite a user to the workspace by email. If the user already has an Ordinal account, they will be added to the workspace immediately. Otherwise, an invite email will be sent.

POST/invites

Authorization

AuthorizationBearer token · headerrequired

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

Request body

requiredapplication/json

emailstring<email>required

The email address of the user to invite

Responses

200

Invite created or user added to workspace

inviteobject | null

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

Show properties

idstring<uuid>

The unique identifier of the invite

emailstring<email>

The email address of the invited user

createdAtstring<date-time>

When the invite was created

sentEmailboolean

Whether an invite email was sent

400

Bad Request - Invalid input parameters

codestring

messagestring

dataobject

Show properties

errorsobject

401

Unauthorized - Missing or invalid API key

codestring

messagestring

403

Forbidden - Insufficient permissions

codestring

messagestring

409

Conflict - Resource already exists

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

emailstring*The email address of the user to invite

Request

curl -X POST 'https://app.tryordinal.com/api/v1/invites' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "newuser@example.com"
}'

const response = await fetch("https://app.tryordinal.com/api/v1/invites", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"newuser@example.com\"\n}"
});

import requests

response = requests.post(
    "https://app.tryordinal.com/api/v1/invites",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"newuser@example.com\"\n}",
)

Response

{
  "invite": {
    "id": "550e8400-e29b-41d4-a716-446655440500",
    "email": "newuser@example.com",
    "createdAt": "2026-01-15T10:00:00.000Z"
  },
  "sentEmail": true
}

{
  "code": "BAD_REQUEST",
  "message": "Bad Request",
  "data": {
    "errors": {
      "publishAt": [
        "Invalid date format"
      ],
      "status": [
        "Invalid enum value"
      ]
    }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid or unauthorized API key"
}

{
  "code": "FORBIDDEN",
  "message": "Engagement profiles cannot be used for analytics"
}

{
  "code": "CONFLICT",
  "message": "Label with name \"Marketing\" already exists"
}