logo

Integration Connection

This document describes the API for reading and archiving Integration Connections.

List Integration Connections

Returns a list of Integration Connections.

Search parameters

Filter Description
id The ID of the Integration Connection
name The name of the Integration Connection if applicable
status The status of the Integration Connection
updated_at The date this Integration Connection was last updated
vendor_name The name of the vendor for this Integration Connection
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 1000 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Integration Connection data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/integration_connections
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get an Integration Connection
Returns an Integration Connection by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/integration_connections/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Archive an Integration Connection
Archives an Integration Connection by ID.


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
put/integration_connections/{id}/archive
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to Repository