Skip to main content

Get Integration by ID

Overview

Returns a single integration by UUID. The secret is never returned — it is only shown once when the integration is created.

Endpoint: GET /api/v1/integrations/{id}

Authentication: Bearer token (JWT) required.


Request

Headers

HeaderRequiredDescription
AuthorizationYesBearer <your_jwt_token>

Path Parameters

ParameterTypeRequiredDescription
idstringYesIntegration UUID

Response

Success — 200 OK

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

Note: The secret field is never returned for existing integrations.

Example Response

{
"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"
}

Error Responses

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

cURL Example

curl -X GET https://api.example.com/api/v1/integrations/550e8400-e29b-41d4-a716-446655440001 \
-H "Authorization: Bearer YOUR_JWT_TOKEN"