Supaglue
Supaglue is an open-source unified API platform that enables B2B SaaS developers to build product integrations with CRM, HRIS, sales engagement, ticketing, and other business applications. It provides a unified API layer that abstracts away provider-specific differences, managed OAuth authentication, data syncing to data warehouses (BigQuery, Snowflake, Redshift, Postgres), and a management API for configuring customers, connections, and sync configurations. Supported providers include Salesforce, HubSpot, Pipedrive, Zendesk, Slack, and 15+ others. The platform is available as a managed cloud service (api.supaglue.io) and as a self-hosted open-source deployment. The GitHub organization is github.com/supaglue-labs.
APIs
Supaglue Management API
The Supaglue Management API configures all aspects of the integration platform. Manages customers (the end users of the integrations), their connections to third-party providers...
Supaglue Unified CRM API
The Supaglue Unified CRM API provides a single interface for reading and writing CRM data across Salesforce, HubSpot, Pipedrive, and other providers. Supports accounts, contacts...
Supaglue Unified Engagement API
The Supaglue Unified Engagement API provides a single interface for reading and writing sales engagement data across Outreach, Salesloft, Apollo, and other sales engagement plat...
Supaglue Unified Ticketing API
The Supaglue Unified Ticketing API (Preview) provides a single interface for reading ticketing and support data across Zendesk, Linear, and other ticketing platforms. Supports a...
Collections
Unified CRM API
OPENManagement API
OPENPricing Plans
Rate Limits
FinOps
Supaglue Finops
FINOPSSemantic Vocabularies
API Governance Rules
JSON Structure
Example Payloads
Resources
Sources
opencollection: 1.0.0
info:
name: Unified Ticketing API (Preview)
version: 0.25.7
items:
- info:
name: Accounts
type: folder
items:
- info:
name: List accounts
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/accounts
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Account objects.
'
- info:
name: Get account
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/accounts/:account_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: account_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns an Account object with the given id.
'
- info:
name: Collections
type: folder
items:
- info:
name: List collections
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/collections
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Collection objects.
'
- info:
name: Get collection
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/collections/:collection_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: collection_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a Collection object with the given id.
'
- info:
name: List collection users
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/collections/:parent_id/users
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: parent_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of User objects.
'
- info:
name: Users
type: folder
items:
- info:
name: List users
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/users
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of User objects.
'
- info:
name: Get user
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/users/:user_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: user_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a User object with the given id.
'
- info:
name: Contacts
type: folder
items:
- info:
name: List contacts
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/contacts
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Contact objects.
'
- info:
name: Get contact
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/contacts/:contact_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: contact_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a Contact object with the given id.
'
- info:
name: Teams
type: folder
items:
- info:
name: List teams
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/teams
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Team objects.
'
- info:
name: Get team
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/teams/:team_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: team_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns an Team object with the given id.
'
- info:
name: Tickets
type: folder
items:
- info:
name: List tickets
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/tickets
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Ticket objects.
'
- info:
name: Create ticket
type: http
http:
method: POST
url: https://api.supaglue.io/ticketing/v2/tickets
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
body:
type: json
data: '{}'
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: Creates a Ticket object with the given values.
- info:
name: Get ticket
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/tickets/:ticket_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: ticket_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns an Ticket object with the given id.
'
- info:
name: Update ticket
type: http
http:
method: PATCH
url: https://api.supaglue.io/ticketing/v2/tickets/:ticket_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: ticket_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
body:
type: json
data: '{}'
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: Updates a Ticket object with the given values.
- info:
name: Comments
type: folder
items:
- info:
name: List comments
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/comments
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Comment objects.
'
- info:
name: Create comment
type: http
http:
method: POST
url: https://api.supaglue.io/ticketing/v2/comments
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
body:
type: json
data: '{}'
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: Creates a Comment object with the given values.
- info:
name: Get comment
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/comments/:comment_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: comment_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a Comment object with the given id.
'
- info:
name: Tags
type: folder
items:
- info:
name: List tags
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/tags
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Tag objects.
'
- info:
name: Get tag
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/tags/:tag_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: tag_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a Tag object with the given id.
'
- info:
name: Attachments
type: folder
items:
- info:
name: List attachments
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/attachments
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: modified_after
value: '2023-02-23T00:00:00Z'
type: query
description: If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format
and URI encoded.
- name: page_size
value: '123'
type: query
description: 'Number of results to return per page. (Max: 1000)'
- name: cursor
value: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
type: query
description: The pagination cursor value
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns a list of Attachment objects.
'
- info:
name: Create attachment
type: http
http:
method: POST
url: https://api.supaglue.io/ticketing/v2/attachments
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
body:
type: json
data: '{}'
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: Creates a Attachment object with the given values.
- info:
name: Get attachment
type: http
http:
method: GET
url: https://api.supaglue.io/ticketing/v2/attachments/:attachment_id
headers:
- name: x-customer-id
value: my-customer-1
- name: x-provider-name
value: salesforce
params:
- name: attachment_id
value: 0258cbc6-6020-430a-848e-aafacbadf4ae
type: path
- name: include_raw_data
value: 'true'
type: query
description: Whether to include raw data fetched from the 3rd party provider.
auth:
type: apikey
key: x-api-key
value: '{{x-api-key}}'
placement: header
docs: ':::note
This feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com)
for more information.
:::
Returns an Attachment object with the given id.
'
bundled: true