Integration
Authorizations
x-api-keystringRequired
Query parameters
activebooleanOptionalDefault:
trueResponses
200
Integrations retrieved successfully
application/json
integrationIdstringRequired
customerIntegrationIdstringRequired
activebooleanRequired
namestringRequired
descriptionstringOptional
logoUrlstringOptional
hoststringRequired
updatedAtstring · date-timeRequired
createdAtstring · date-timeRequired
authTypestring · enumOptionalPossible values:
Currently active authentication type for the integration.
401
Unauthorized - invalid API key
500
Internal server error
get
/v1/integrationsAuthorizations
x-api-keystringRequired
Path parameters
customerIntegrationIdstringRequired
Customer integration ID
userIdstringRequired
User ID associated with the integration
Responses
200
Integration user retrieved successfully
application/json
userIdstringRequired
activebooleanRequired
updatedAtstring · date-timeRequired
createdAtstring · date-timeRequired
401
Unauthorized - invalid API key
500
Internal server error
get
/v1/integrations/{customerIntegrationId}/users/{userId}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
201
Auth URL generated successfully
application/json
401
Unauthorized - invalid API key
500
Internal server error
post
/v1/integrations/{customerIntegrationId}/users/{userId}/auth-urlLast updated