Skip to main content
POST
/
api
/
api-keys
curl --request POST \
  --url https://api-next.dealroom.co/api/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "m2m",
  "name": "Production data pipeline",
  "permissions": [
    "read:entities",
    "read:investors",
    "read:transactions"
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "client_id": "<string>",
    "permissions": [
      "<string>"
    ],
    "allowed_origins": [
      "<string>"
    ],
    "allowed_callback_urls": [
      "<string>"
    ],
    "last_used_at": "<string>",
    "created_at": "<string>",
    "created_by": "<string>",
    "client_secret": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.beta.dealroom.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. Paste a token obtained from your preferred OAuth2 flow. For machine-to-machine use, the OAuth2 client_credentials scheme below can mint a token directly from your client_id / client_secret inside the Swagger UI Authorize dialog.

Body

application/json
​
type
enum<string>
required

Programmatic key using client_credentials grant — server-side only.

Available options:
m2m
Example:

"m2m"

​
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

​
data
object
required