ApproveSimpleā„¢ Documentation Site

Welcome to the ApproveSimple documentation site. You'll find comprehensive guides and documentation to help you start working with ApproveSimple as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
 
 
 
Suggest Edits

Overview

This page will help you get started with Management API.

 

Management reference APIs allows customers to manage entities within the organization

 
Suggest Edits

Users

Users Management APIs

 

User Management reference APIs allow customers to add, update and delete ApproveSimple users and to add, update and delete user mappings to source systems ID's.

 
Suggest Edits

Get users

Get all users in your organization

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v1/users
 
curl --request GET \
  --url https://api.approvesimple.com/v1/users
var request = require("request");

var options = { method: 'GET', url: 'https://api.approvesimple.com/v1/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v1/users");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "uuid",
    "email": "string",
    "firastName": "string",
    "lastName": "string",
    "orgId": "uuid"
  }
]
 
Suggest Edits

Add users

Add users to your organization

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.approvesimple.com/v1/orgs/id/users/bulk

Path Params

id
string
required

org id

Body Params

array of objects
required

Array of user objects to add

email
firstName
lastName

The maximum size of the body payload must not exceed 100K bytes

curl --request POST \
  --url https://api.approvesimple.com/v1/orgs/id/users/bulk
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.approvesimple.com/v1/orgs/id/users/bulk' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/orgs/id/users/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.approvesimple.com/v1/orgs/id/users/bulk");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/orgs/id/users/bulk"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

An array containing the success or failure status of 
every added user
{
  "Error": "Unauthorized. [Authentication] failed to get token data"
}
 
Suggest Edits

Delete users

Delete users from your organization

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.approvesimple.com/v1/users

Body Params

array of strings
required

Array with user ids to delete

The maximum size of the body payload must not exceed 100K bytes

curl --request DELETE \
  --url https://api.approvesimple.com/v1/users
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.approvesimple.com/v1/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.approvesimple.com/v1/users");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/users"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "Error": "Not Found. Failed to find the an item users 789c4629-9da8-41d6-9c06-71f1dc337238"
}
 
Suggest Edits

Get user mappings

Get user mappings of a specific user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v1/users/id/usermappings

Path Params

id
string
required

user id

 
curl --request GET \
  --url https://api.approvesimple.com/v1/users/id/usermappings
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v1/users/id/usermappings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/users/id/usermappings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v1/users/id/usermappings");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/users/id/usermappings"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "systemUserId": "string",
    "systemId": "uuid",
    "userId": "uuid"
  }
]
 
Suggest Edits

Get system user mappings

Get user mappings of a specific system

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v1/systems/id/usermappings

Path Params

id
string
required

system id

 
curl --request GET \
  --url https://api.approvesimple.com/v1/systems/id/usermappings
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v1/systems/id/usermappings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/systems/id/usermappings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v1/systems/id/usermappings");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/systems/id/usermappings"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "systemUserId": "string",
    "systemId": "uuid",
    "userId": "uuid",
  }
]
{
  "Error": "Not Found. Failed to find the an item systems 17c4bc76-aeb4-4900-b6c7-4f8c868e4546"
}
 
Suggest Edits

Add user mappings

Add user mappings to a system

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.approvesimple.com/v1/systems/id/usermappings/bulk

Path Params

id
string
required

Body Params

array of objects

[{"userId":"user1-id-in-capriza","systemUserId":"user1-id-in-system"}, {"userId":"user2-id-in-capriza","systemUserId":"user2-id-in-system"}]

userId
systemUserId
 
curl --request POST \
  --url https://api.approvesimple.com/v1/systems/system%20id/usermappings/bulk
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.approvesimple.com/v1/systems/system%20id/usermappings/bulk' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/systems/system%20id/usermappings/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.approvesimple.com/v1/systems/system%20id/usermappings/bulk");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/systems/system%20id/usermappings/bulk"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Systems

Systems Management reference APIs

 
 
 
Suggest Edits

Get systems

Get systems in the organization

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v1/systems
 
curl --request GET \
  --url https://api.approvesimple.com/v1/systems
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v1/systems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v1/systems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v1/systems");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v1/systems"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "uuid",
    "name": "string",
    "orgId": "uuid"
  }
]
 
 

Integration reference APIs allows developers to develop a connector

 
Suggest Edits

Approvals

 

Approvals Integration reference APIs allows developers to synchronize approvals from the source system to ApproveSimple.

 
Suggest Edits

Get approval

Get approval by ID

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v2/rawapprovals/approvalId

Path Params

approvalId
string
required

ID of approval to return

 
curl --request GET \
  --url https://api.approvesimple.com/v2/rawapprovals/approvalId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v2/rawapprovals/approvalId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/rawapprovals/approvalId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v2/rawapprovals/approvalId");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/rawapprovals/approvalId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "data": {
    "approval": {
      "id": "string",
      "schemaId": "string",
      "approver": "string",
      "resolved": "boolean",
      "lastModified": "date-time",
      "data": {}
    }
  }
}
{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Update approval

Update approval by ID.

The approval will be updated only if the property "lastModified" of the new approval will be grater than the same property of the existing approval.

If the property "lastModified" doesn't exist in the new approval, the existing approval will be updated anyway.

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.approvesimple.com/v2/rawapprovals/approvalId

Path Params

approvalId
string
required

ID of approval to update

Body Params

approval
object
required
 
approval.schemaId
string

The schema ID that the approval related to

approval.approver
string

Unique id of the approver

approval.resolved
boolean

Indication if this approval is waiting for an action to be resovled

approval.lastModified
timestamp

The last time that the approval was modified

approval.data
object

Approval data to be shown in the app

 
 
curl --request PUT \
  --url https://api.approvesimple.com/v2/rawapprovals/approvalId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.approvesimple.com/v2/rawapprovals/approvalId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/rawapprovals/approvalId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.approvesimple.com/v2/rawapprovals/approvalId");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/rawapprovals/approvalId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Get approvals

Get list of the last 50 approval requests.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v2/rawapprovals

Query Params

lastModified[gt]
date-time

Get approvals records that last modified time is grather than this value.

resolved
boolean

Retrive approvals that are resolved (not waiting for approval).

view
string

Either "full" (returns the entire approval) or "shallow" (returns approval without data property).

 
curl --request GET \
  --url https://api.approvesimple.com/v2/rawapprovals
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v2/rawapprovals' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/rawapprovals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v2/rawapprovals");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/rawapprovals"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "data": {
    "approvals": [
 			 {
        "id": "string",
        "schemaId": "string",
        "approver": "string",
        "resolved": "boolean",
        "lastModified": "date-time",
        "data": {}
		  }
		]
  }
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Update approvals

Update approval requests list.

Each approval in the list will be updated only if the property "lastModified" of the new approval will be grater than the same property of the existing approval.

If the property "lastModified" doesn't exist in the new approval, the existing approval will be updated anyway.

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.approvesimple.com/v2/rawapprovals

Body Params

approvals
array of objects

List of approvals to update

id 
schemaId
approver
resolved
lastModified
data 
 
curl --request PUT \
  --url https://api.approvesimple.com/v2/rawapprovals
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.approvesimple.com/v2/rawapprovals' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/rawapprovals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.approvesimple.com/v2/rawapprovals");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/rawapprovals"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "success"
}
 
Suggest Edits

Connector

 

Connector Integration Reference APIs allow developers to

  • synchronize data between the source system and ApproveSimple
  • get and update connector-related values
 
Suggest Edits

Update connector

Updates the connector data

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.approvesimple.com/v2/connector

Body Params

object
 
taskTypes
array of strings

supported actions by the connector

authRequired
boolean

True if actions like approve or reject are required authenticate before execute the action

publicKey
string

Public key for end to end encryption. Required when authRequired=true

publicKeyExpiredAt
datetime

Public key expiration for end to end encryption. Required when authRequired=true

 
curl --request PATCH \
  --url https://api.approvesimple.com/v2/connector
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.approvesimple.com/v2/connector' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.approvesimple.com/v2/connector");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Get task

Get a task to execute

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v2/connector/tasks
 
curl --request GET \
  --url https://api.approvesimple.com/v2/connector/tasks
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v2/connector/tasks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v2/connector/tasks");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector/tasks"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "data": {
    "task": {
      "id": "uuid",
      "type": "string",
      "data": {
        "approval": {
        },
        "approveComments": "string"
      }
    }
  }
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Update task

Update task result by ID

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://api.approvesimple.com/v2/connector/tasks/taskId

Path Params

taskId
string
required

ID of task to update

Body Params

taskResult
object
required

Task result data

 
taskResult.status
string
required

One of success, internalError, authenticationError, serviceUnavailable, systemError

taskResult.meta
object

Additional information of the task result

 
 
curl --request PATCH \
  --url https://api.approvesimple.com/v2/connector/tasks/taskId
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.approvesimple.com/v2/connector/tasks/taskId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector/tasks/taskId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.approvesimple.com/v2/connector/tasks/taskId");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector/tasks/taskId"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Get state

Get connector state

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v2/connector/state
 
curl --request GET \
  --url https://api.approvesimple.com/v2/connector/state
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v2/connector/state' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector/state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v2/connector/state");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector/state"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "data": {
    "state": {
      "id": "uuid",
      "createdAt": "date-time",
      "updatedAt": "date-time",
      "state": {}
    }
  }
}


{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Update state

This API allows to set state related to the connector.

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.approvesimple.com/v2/connector/state

Body Params

state
object
required

State of the connector to set

 
 
curl --request PUT \
  --url https://api.approvesimple.com/v2/connector/state
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.approvesimple.com/v2/connector/state' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector/state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.approvesimple.com/v2/connector/state");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector/state"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Get ui-templates

Get UI templates related to the connector

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v2/connector/ui-templates
 
curl --request GET \
  --url https://api.approvesimple.com/v2/connector/ui-templates
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v2/connector/ui-templates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector/ui-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v2/connector/ui-templates");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector/ui-templates"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "data": {
    "uiTemplates": [
      {
        "id": "uuid",
        "type": "string",
        "uiTemplate": {
          "<schemaId>": {}
        }
      }
    ] 
  }
}
{
  "status": "failure"
}
{
  "status": "failure"
}
 
Suggest Edits

Update ui-templates

Add or update UI templates related to the connector

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.approvesimple.com/v2/connector/uitemplates

Body Params

uiTemplates
array of objects
type
schemaId
template 
 
curl --request GET \
  --url https://api.approvesimple.com/v2/connector/uitemplates
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.approvesimple.com/v2/connector/uitemplates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.approvesimple.com/v2/connector/uitemplates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.approvesimple.com/v2/connector/uitemplates");

xhr.send(data);
import requests

url = "https://api.approvesimple.com/v2/connector/uitemplates"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": "success"
}
{
  "status": "failure"
}
{
  "status": "failure"
}
{
  "status": "failure"
}