Skip to main content
Integration connections are the integrations set up on your Exsited instance. You can list them, filtered by status, and read one by its uuid. This area has 2 endpoints, and all seven SDKs call every one.

At a glance

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

  • Filter by status with filter_status. The values are ACTIVE, INACTIVE and DISCONNECTED; any other value returns 400.
  • Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
  • A limit of 0 returns 400. Ask for at least one record per page.
  • Read one connection by its uuid. Take the uuid of a record in the listing and pass it as integration_connection_id.