API Reference

Management API

Get Auth Requirements

Get Auth Requirements

GEThttp://localhost:3001/dev/api/authorize

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/authorize', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Auth (Callback)

Auth (Callback)

POSThttp://localhost:3001/dev/api/authorize

Body

application/json

dataobject

entityTypestring

Response

201

OAuth Example

Body

text/plain

any

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/authorize', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"entityType\":\"{{targetEntityType}}\",\n    \"data\": {\n        \"subdomain\": {{userProvidedSubdomain}},\n        \"public_key\": {{userProvidedPublicKey}},\n        \"private_key\": {{userProvidedPrivateKey}}\n    }\n}"),
});
const data = await response.json();

Get Entity Options

Get Entity Options

GEThttp://localhost:3001/dev/api/entities/options/{credentialId}

Path parameters

credentialId*string

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/entities/options/{credentialId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create Entity

Create Entity

POSThttp://localhost:3001/dev/api/entities

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/entities', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

List Integrations

List Integrations

GEThttp://localhost:3001/dev/api/integrations

Header parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create Integration

Create Integration

POSThttp://localhost:3001/dev/api/integrations

Authorization

bearerAuth

Body

application/json

entitiesarray of string

Response

201

Create Integration

Body

text/plain

any

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "entities": [
        "{{yourAppEntityId}}",
        "{{targetAppEntityId}}"
      ]
    }),
});
const data = await response.json();

List Integration Options

List Integration Options

GEThttp://localhost:3001/dev/api/integrations/options

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/options', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Integration

Get Integration

GEThttp://localhost:3001/dev/api/integrations/{integrationId}

Path parameters

integrationId*string

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/{integrationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Delete Integration

Delete Integration

DELETEhttp://localhost:3001/dev/api/integrations/{integrationId}

Path parameters

integrationId*string

Body

application/json

idstring

Response

202

Delete Integration

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/{integrationId}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "integration1"
    }),
});
const data = await response.json();

Response

{}

Update Integration

Update Integration

PATCHhttp://localhost:3001/dev/api/integrations/{integrationId}

Path parameters

integrationId*string

Header parameters

Body

application/json

configobject

idstring

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/{integrationId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "config": {
        "enable": {
          "sync": true,
          "webhooks": false
        },
        "map": {
          "syncMap": {
            "freshbooksEntityId": [
              "name.first",
              "name.last"
            ],
            "salesforceEntityId": [
              "firstName",
              "lastName"
            ]
          }
        }
      },
      "id": "integration1"
    }),
});
const data = await response.json();

Get Integration Config Options

Get Integration Config Options

GEThttp://localhost:3001/dev/api/integrations/{integrationId}/config/options

Path parameters

integrationId*string

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/{integrationId}/config/options', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get User Action Options

Get User Action Options

GEThttp://localhost:3001/dev/api/integrations/{integrationId}/actions/{actionId}/options

Path parameters

integrationId*string

actionId*string

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/{integrationId}/actions/{actionId}/options', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Submit User Action

Submit User Action

POSThttp://localhost:3001/dev/api/integrations/65bbfe8e4124ba1e42b939e4/actions/DELETE_ALL_CUSTOM_OBJECTS

Authorization

bearerAuth

Response

200

Request

JavaScriptCurl

const response = await fetch('http://localhost:3001/dev/api/integrations/65bbfe8e4124ba1e42b939e4/actions/DELETE_ALL_CUSTOM_OBJECTS', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();