List integrations (automations) from account
GET /accounts/{account_externalid}/blends
List all the integrations (automations) in one customer account.
Fields of blend:
- guid
- name
- short description
- description
- icon (full url)
- icon2 (full url)
- icon3 (full url)
- status (live, hidden, coming_soon)
- created_at (timestamp creation = activation by customer)
- updated_at (timestamp last update)
- last_run_at
- has_setup
- has_settings
- isbundle (bundles are automations that have sub_blends)
- sub_automations (only if isbundle is true)
- setup_complete
- template_guid
- run_mode
- admin_url: link to the Settings UI of this active integration
- admin_sso_url: link to the Settings UI of this active integration, with SSO (make sure to add all SSO parameters)
This endpoint is typically used to list active integrations in the UI of your SaaS platform when you use the deep embedding
scenario, which means you are not using an iframe for embedding.
You can add a link to each individual integration in your UI, allowing your customer to manage the integration (change settings etc.). This embedding will typically use an SSO link that opens the detail page of the integration e.g. in a frame, modal or new browser window. You can use the admin_sso_url to link directly to one specific integration (deep link). Make sure to add all required SSO parameters. See the SSO article for more information.
Path Parameters
| Name | Description | Type |
|---|---|---|
| account_externalid | - | string |
Results
200
{
"data": [
{
"guid": "xxx",
"name": "My integration",
"short_description": null,
"description": null,
"icon": "",
"icon2": null,
"icon3": null,
"status": "live",
"created_at": "2019-06-16T07:38:41+00:00",
"updated_at": "2019-06-16T07:38:41+00:00",
"last_run_at": null,
"has_setup": false,
"has_settings": false,
"isbundle": false,
"setup_complete": false,
"template_guid": null,
"run_mode": "manual",
"admin_url": "https://.../widgets/xxx"
}
],
"links": {
"first": "/v1/accounts/xxx/blends?page=1",
"last": "/v1/accounts/xxx/blends?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "/v1/accounts/xxx/blends",
"per_page": 100,
"to": 1,
"total": 1
}
}
400
{}
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!