Skip to main content
GET
/
v2
/
integrations
/
providers
List Providers
curl --request GET \
  --url https://api.example.com/v2/integrations/providers \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "bill",
    "categories": [
      "accounting"
    ],
    "display_name": "<string>",
    "is_api_connection": true,
    "is_webhooks_supported": true,
    "auth_type": "api_key",
    "color": "<string>",
    "connection_guide_url": "<string>",
    "connection_instructions": [
      "<string>"
    ],
    "documentation_url": "<string>",
    "description": "<string>",
    "is_enabled": true,
    "is_manual_sync_supported": true,
    "logo": "<string>",
    "logo_square": "<string>",
    "required_settings": [
      "<string>"
    ],
    "short_description": "<string>",
    "website": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

​
name
enum<string>
required

Unique name for the integration provider. Note: must contain only alphanumeric characters and dashes(-)

Available options:
bill,
ms-dynamics-bc,
ms-dynamics-fo,
netsuite,
quickbooks,
quickbooks-desktop,
sage-intacct,
salesforce-accountingseed,
sample-data-generator,
zuora
​
categories
enum<string>[]
required
Available options:
accounting,
banking,
communication,
crm,
file-storage
​
display_name
string
required
​
is_api_connection
boolean
required

Whether connection to this integration provider is done through an API.

​
is_webhooks_supported
boolean
required

Whether or not the integration is enabled

​
auth_type
enum<string> | null
Available options:
api_key,
basic,
custom,
oauth1,
oauth2,
oauth2_cc
​
color
string | null
​
connection_guide_url
string | null
​
connection_instructions
string[] | null
​
documentation_url
string | null

Provider documentation.

​
description
string | null
​
is_enabled
boolean
default:true
​
is_manual_sync_supported
boolean
default:true

Whether this integration supports manually triggering sync.

​
logo
string | null

URL to the provider's logo.

​
logo_square
string | null

URL to the provider's square logo.

​
required_settings
string[]
​
short_description
string | null
​
website
string | null