Create workspace API key

Create an API key for a specific workspace. The key can be used to access workspace-specific endpoints.

POST/workspaces/{workspaceId}/api-keys

Authorization

AuthorizationBearer token · headerrequired

Company API key (starts with ord_c_)

Path parameters

workspaceIdstring<uuid>required

Request body

requiredapplication/json

namestringrequired

min length 1

Responses

200

idstring<uuid>required

namestringrequired

keyHintstringrequired

keystringrequired

createdAtstring<date-time>required

400

Bad Request - Invalid input parameters

codestring

messagestring

errorsobject

401

Unauthorized - User is not authenticated

statusnumber

messagestring

404

Not Found - Resource does not exist

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

workspaceIdpath*

Bodyapplication/json

namestring*

Request

curl -X POST 'https://app.tryordinal.com/api/v1/company/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/api-keys' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

const response = await fetch("https://app.tryordinal.com/api/v1/company/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/api-keys", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://app.tryordinal.com/api/v1/company/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/api-keys",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\"\n}",
)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "keyHint": "string",
  "key": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "code": "BAD_REQUEST",
  "message": "Bad Request",
  "data": {
    "errors": {
      "id": [
        "Invalid UUID"
      ],
      "email": [
        "Invalid email address"
      ]
    }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "API key was revoked at 2025-8-24T02:29:50.000Z"
}

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}