Skip to main content

List Integrations

Overview

Returns a paginated list of integrations for a given node. Use page and per_page query parameters for pagination.

Endpoint: GET /api/v1/integrations

Authentication: Bearer token (JWT) required.


Request

Headers

HeaderRequiredDescription
AuthorizationYesBearer <your_jwt_token>

Query Parameters

ParameterTypeRequiredDefaultDescription
node_idstringYesNode UUID to filter integrations
pageintNo1Page number (1–10000)
per_pageintNo10Items per page (1–100, max 100)

Response

Success — 200 OK

FieldTypeDescription
itemsIntegrationResponse[]List of integrations
pageintCurrent page number
per_pageintItems per page
totalint64Total number of integrations

Each item in items has:

FieldTypeDescription
idstringIntegration UUID
node_idstringNode UUID
namestringIntegration name
api_keystringAPI key
permissionsstring[]Permission list
expires_atstringExpiration date (or null)
created_atstringCreation timestamp

Example Response

{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"node_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Production API",
"api_key": "apex_abc123xyz456",
"permissions": ["payments.read", "payments.create"],
"expires_at": "2026-12-31T23:59:59Z",
"created_at": "2025-02-14T10:00:00Z"
}
],
"page": 1,
"per_page": 10,
"total": 42
}

Error Responses

StatusDescription
400Invalid request (validation error)
401Unauthorized (missing or invalid token)
500Internal server error

cURL Example

curl -X GET "https://api.example.com/api/v1/integrations?node_id=550e8400-e29b-41d4-a716-446655440000&page=1&per_page=10" \
-H "Authorization: Bearer YOUR_JWT_TOKEN"