Integration

Get All Integrations

get

Retrieves a list of all integrations, optionally filtered by active status

Authorizations
x-api-keystringRequired
Query parameters
activebooleanOptionalDefault: true
Responses
chevron-right
200

Integrations retrieved successfully

application/json
get
/v1/integrations

Get Integration User

get

Retrieves a user for a specific customer integration

Authorizations
x-api-keystringRequired
Path parameters
customerIntegrationIdstringRequired

Customer integration ID

userIdstringRequired

User ID associated with the integration

Responses
chevron-right
200

Integration user retrieved successfully

application/json
get
/v1/integrations/{customerIntegrationId}/users/{userId}

Generate Integration User Auth URL

post

Generates an auth URL for a specific integration user. User will be created if it does not exist for the integration.

Authorizations
x-api-keystringRequired
Path parameters
customerIntegrationIdstringRequired

Customer integration ID

userIdstringRequired

User ID associated with the integration

Body
redirectUristringOptional

The optional redirect URI to redirect the user to after authentication. Askel will append query param ?status=success/error. If not provided, a default success/failure page will be shown.

Responses
post
/v1/integrations/{customerIntegrationId}/users/{userId}/auth-url

Last updated