Skip to main content
GuidesAPI Reference

Retrieve a single integration

GET 
/integrations/:integrationId

Finds a specific integration for a user

Request​

Path Parameters

    integrationId stringrequired

    This API parameter allows you to filter results based on the integrationId or the integrationName (also referred to as 'app'). The integration name (app) is a custom name that you have set for your integration. When using the integration name (app), provide the name of the integration you want to filter for (e.g. 'shopify order sync' or 'magento product creation'). You can obtain the integration name (app) from the List Integrations endpoint under the 'app' parameter, or by checking your UI. Either integrationId or integrationName must be provided but it cannot be both.

Query Parameters

    userId stringrequired

    The Id used to identify the user. Note: you can also use the Embedded user's username in this field.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    data

    object

    integrationId string
    app string
    installed boolean

    Default value: true

    icon string

    workflows

    object[]

  • Array [

    • workflowId string
    name string
    installed boolean

    Default value: true

    version integer

    Default value: 0

    installedVersion integer

    Default value: 0

    active boolean

    Default value: true

    blocks

    object[]

  • Array [

    • name string
    id string
    type string
    icon string

  • ]

  • ]

Loading...