Skip to main content
POST
/
api
/
api-keys
Create a new API key
curl --request POST \
  --url https://api.example.com/api/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production integration",
  "permissions": [
    "read:entities",
    "read:investors"
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "client_id": "<string>",
    "permissions": [
      "<string>"
    ],
    "last_used_at": "<string>",
    "created_at": "<string>",
    "created_by": "<string>",
    "client_secret": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token

Body

application/json
name
string
required

A human-readable name for the API key

Required string length: 1 - 100
Example:

"Production integration"

permissions
string[]
required

Permissions to grant (must be a subset of your own)

Minimum array length: 1
Example:
["read:entities", "read:investors"]

Response

API key created — client_secret is shown only once

data
object
required