Skip to main content
POST
/
integrators
/
{id}
/
api-keys
Create a new API key for an integrator
curl --request POST \
  --url http://localhost:4000/v1/integrators/{id}/api-keys \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production API Key",
  "description": "API key for production environment"
}
'
{
  "success": true,
  "message": "<string>",
  "statusCode": 123,
  "timestamp": "<string>",
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "name": "Production API Key",
    "description": "API key for production environment",
    "key": "sk_client_v1_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
    "scopes": [
      "INTEGRATOR"
    ],
    "active": true,
    "expiresAt": "2026-01-11T12:00:00.000Z",
    "createdAt": "2025-01-11T12:00:00.000Z"
  },
  "path": "<string>"
}

Authorizations

Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Path Parameters

id
string
required

Integrator ID

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json
name
string
required

Name for the API key

Maximum string length: 255
Example:

"Production API Key"

description
string

Description of the API key usage

Example:

"API key for production environment"

Response

success
boolean
required
message
string
required
statusCode
number
required
timestamp
string
required
data
object
path
string