Get Integrations Details

This endpoint offers you the ability to retrieve details of all integration types that you had enabled in your Whisk Studio account.

get
Get Integrations

https://api.studio.whisk.com/integrations/v1/get
You can use just the base URL and the authentication header to pull details of all Integration types linked to your Whisk Studio account:
Request
Response
Request
Headers
Authentication
required
string
Authentication token to authorize the API usage. For more information, see Authentication.
Response
200: OK
This is how a successful response looks.
{
"integrations": [
{
"id": "string",
"type": "INTEGRATION_TYPE_INVALID",
"status": "INTEGRATION_STATUS_INVALID",
"created_at": "string",
"updated_at": "string"
}
]
}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
"message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound , auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
"code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to help@whisk.com, and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: help@whisk.com

Sample Request and Response

Curl Request
Response
Curl Request
curl -X GET "https://api.studio.whisk.com/integrations/v1/get"
-H "Accept: application/json"
-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"

Note: Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.

Response
{
"integrations": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "INTEGRATION_TYPE_CUSTOM",
"status": "INTEGRATION_STATUS_ENABLED",
"created_at": "1608910441740",
"updated_at": "1608910441740"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "INTEGRATION_TYPE_SALSIFY",
"status": "INTEGRATION_STATUS_DISABLED",
"created_at": "1609768210609",
"updated_at": "1609846831662"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "INTEGRATION_TYPE_SHOPIFY",
"status": "INTEGRATION_STATUS_ENABLED",
"created_at": "1611242960379",
"updated_at": "1611242960379"
}
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "INTEGRATION_TYPE_WORDPRESS",
"status": "INTEGRATION_STATUS_ENABLED",
"created_at": "1611346856098",
"updated_at": "1611346856098"
}
]
}

Note: To understand the data structure of the integrations definition, see Integrations Object.