Visit the Developer Hub for more details ! supports various embedding scenario's for SaaS partners, including a scenario where the SaaS partner uses server-side code to show a list of available integrations and a list of active integrations per user or account.

In this scenario, the SaaS Partner API can be used to retrieve a list of available integrations and activate integrations per account.

Base URL


Use the app id and API key from your SaaS Admin account, and add them as headers:

X-App-Id: 12345
X-Api-Key: xxxxx


List available integrations (Templates)

GET /templates

Fields in response per template:

  • guid
  • name
  • icon (full url)
  • icon2 (full url)
  • icon3 (full url)
  • description
  • status
  • has_setup
  • has_settings
  • isbundle (bundles are templates that have sub templates in sub_blends)
  • sub_blends (only if isbundle is true)
  • groups (array, per group: group_name, group_id)
  • activation_url: link to the Setup UI, to setup the integration

List, get and delete accounts

GET /accounts
GET /accounts/{account_externalid}
DELETE /accounts/{account_externalid}

Returns (or deletes) your existing accounts, created via SSO (single sign on).

account_externalid is your account id that you have sent to as part of the SSO process.

Fields in response per account:

  • guid
  • externalid
  • name
  • created_at

List & get active integrations (Blends) for one customer

GET /accounts/{account_externalid}/blends
GET /accounts/{account_externalid}/blends/{blend_guid}

Returns active integrations (Blends) of one account.

Fields in response per Blend:

  • guid
  • name
  • 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 blends that have sub_blends)
  • sub_blends (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)

The above endpoints are typically used to list active integrations in the UI of your SaaS platform. 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 e.g. in a frame, modal or new browser window. You can use 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.

Create a Blend in an account

Create a Blend from a template:
POST accounts/{account_externalid}/blends/{template_guid}

Update a Blend based on a template:
PUT accounts/{account_externalid}/blends/{template_guid}/{blend_guid}

Body should contain a JSON object with key/values representing inputs for Setup and Settings flow. The keys must be identical to the input names in the flows. The Setup and Settings flow will pick inputs from this object as needed. Example:

  "create_leads": "Yes",
  "update_leads": "no",
  "segment_id": 12345

Delete a Blend in an account

DELETE /accounts/{account_externalid}/blends/{blend_guid}

List & get runs (history of jobs) of Blends

GET /accounts/{account_externalid}/blends/{blend_guid}/runs
GET /accounts/{account_externalid}/blends/{blend_guid}/runs/{run_guid}

Fields in response per run:

  • guid
  • status
  • context
  • schedule_starttime
  • starttime
  • stoptime
  • created_at
  • updated_at
  • in future release: inputs, outputs, errors

Execute Blends

POST /blends/{blend_guid}/run

List all connectors

Accept: application/json

Did this answer your question?