Integry's integrations listing endpoint enables you to return all integration in the user account. It will filter integrations with the status
creation_in_progress
if you pass a query string parameter. By calling this endpoint, you can list all your integrations in any part of your app./partners/api/bundle/<bundle_id/integrations
Returns a JSON object with an array containing all integrations with the status 'creation_in_progress.'
Required parameters
-
Query parameters:
- user_id: The unique ID of the logged-in user for whom you are retrieving the list of flows
- app_key: The unique public key of your app
- status: In this case, it would be
CREATION_IN_PROGRESS
- Headers: Add your api-key to the request header to authenticate the request.
Please note that the
bundle_id
, user_id
, and app_key
should be the same as used in the SDK embed.Code samples
HTTP
GET https://app.integry.io/partners/api/bundle/<bundle_id>/integrations?user_id=<user_id>&app_key=<your_app_key>&status=<status> api-key: <your_api_key>
cURL
curl --request GET 'https://app.integry.io/partners/api/bundle/<bundle_id>/integrations/?user_id=<user_id>&app_key=<your_app_key>&status=<status>' --header 'api-key: <your_api-key>'
HTTP response status codes
200
: Returned if the call is successful400
: Returned in case of invalid app_key
403
: Returned in case of invalid authentication parameters (api-key
)404
: Returned in case of invalid bundle_id
Sample response
[ { "id": 167598, "name": "aa", "template": 11453, "template_detail": { "id": 11453, "name": "Mailchimp contacts", "description": "Synchronize your Mailchimp contacts to your Sendinblue contacts in real time" }, "icon_url": "https://storage.googleapis.com/app-services-prod--bucket/public/5ea23571-8ed9-4192-9ca8-1038c8db90f2.png", "tooltip": "From Mailchimp: it takes approximately \n3min36 to import 1000 contacts", "status": "CREATION_IN_PROGRESS", "bundle_instance": 30093, "is_visible": 1, "branding_app": { "id": 449, "name": "Mailchimp", "description": "Mailchimp is a marketing automation platform and an email marketing service and a trading name of its operator, Rocket Science Group, an American company founded in 2001. Mailchimp began as a paid service and added a freemium option in 2009.", "icon_url": "https://storage.googleapis.com/app-services-prod--bucket/public/1f157e32-6787-4c51-be4f-deacba83c070.png", "color": null, "publishing_status": "PUBLISHED", "category": [], "show_product_page": false, "app_type": "INTEGRY", "action_url": null, "created_at": "2020-09-16T11:22:44.477000Z", "tags": "", "long_description": "Speak to your customers the way they want to hear it through customized newsletters. Using landing pages and forms grow the number of your subscribers. Import your entire email lists and start using the inbuilt templates to touch the hearts of your customers. Schedule the email you want to go out at any particular time. With reports provided by Mailchimp, get a detailed insight into your email campaigns and every single subscriber on your list. The subscribers created in Mailchimp automatically sync with Integry.", "terms_and_conditions_url": "https://mailchimp.com/legal/terms/", "privacy_policy_url": "https://mailchimp.com/legal/privacy/", "app_documentation_link": "https://mailchimp.com/developer/", "website_link": "https://www.mailchimp.com", "facebook_url": null, "linkedin_url": null, "twitter_url": null, "images": [], "support_email_address": null, "support_website_link": null }, "task_execution": { "last_execution_at": null, "status": null, "integration_created_at": "2023-01-26 13:59:18" }, "created": "2023-01-26T13:59:18.015452Z", "last_modified": "2023-01-26T14:23:50.051689Z", "is_end_user_integration": false, "runs_count": 0 }, .... ]
Response fields
-
id
: The unique identifier of the integration. -
name
: The name of the integration. -
template
: The identifier of the integration's template. -
template_detail
: An object containing details about the integration's template, including its name and description. -
icon_url
: The URL for the integration's icon. -
tooltip
: A tooltip with additional information about the integration. -
status
: The current status of the integration. Options include:"ACTIVE"
"INACTIVE"
"AUTH_MISSING"
"CREATION_IN_PROGRESS"
"CREATION_FAIL"
-
bundle_instance
: The unique identifier of the integration's bundle instance (each user is linked to an individual bundle instance). -
is_visible
: A boolean value indicating whether the integration is visible to users. -
branding_app
: An object containing details about the app associated with the integration, including its name, description, icon URL, and other information. -
task_execution
: An object containing information about the last time the integration's task was executed, including the timestamp and status of the execution. -
created
: The timestamp for when the integration was created. -
last_modified
: The timestamp for when the integration was last modified. -
runs_count
: The number of times this integration has ran.
Comments
0 comments
Please sign in to leave a comment.