Interacting with integrations

Integrations all follow a similar endpoint:

Endpoint

Method URI Headers
{method} /api/v1/integrations/{integration_key}/{action_key} {"Authorization": "Bearer {access_token}"}

Where:
method The method defined to the specific action you are calling
integration_key The identifier for the integration you are calling ie: lending-qb,plaid, etc.
action_key The identifier for the action to this integration you are calling ie: leads,lead/id, etc.

Each endpoint identifies an action for a specific integration. Details on each available action per integration is located in the Available Integrations section.

Data Params

As the api calls are formatted per the jsonapi.org schema, data passed to a specific action will be contained within a data property. Similarly, client credentials can be sent using the credentials_raw or credential properties.
data Data object to be passed to a specific integration's action
credential A previously generated credential id which links to a client's stored credentials object
credentials_raw An object to be sent to the integration for authenticating the client

More information on sending client credentials are located here.

{success} Success Response

Code: 200

Content

{
    "data": "Response data returned from the given action"
}