createIntegrationToken

POST

/api/v1/integration-tokens

curl --request POST \
  --url https://example.com/api/v1/integration-tokens \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "scopes": [ "data_source:write" ], "dataSourceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "expiresAt": "2026-04-15T12:00:00Z" }'

Mint an integration token: a standing inbound capability for data sources or activity reads. Requires an Owner with the admin scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters

scopes

required

Array<string>

Allowed values: data_source:write activity:read

dataSourceIds

Array<string>

expiresAt

string format: date-time

Responses

201

Integration token created with one-time secret

Media typeapplication/json

object

data

required

The secret is returned exactly once. There is no endpoint that reads it back.

object

token

required

object

id

required

string format: uuid

name

required

string

publicId

required

string

scopes

required

Array<string>

Allowed values: data_source:write activity:read

dataSourceIds

required

Array<string>

createdAt

required

string format: date-time

createdBy

string format: uuid

expiresAt

string format: date-time

lastUsedAt

string format: date-time

revokedAt

string format: date-time

secret

required

string

notice

required

string

Example

{
  "data": {
    "token": {
      "scopes": [
        "data_source:write"
      ]
    }
  }
}

400

Invalid request body

401

Dashboard authentication required

403

Insufficient role

422

Token invalid