Get Integration History

Get
/api/v1/integrations.history

Any of the following permissions is required:

  • manage-incoming-integrations
  • manage-own-incoming-integrations
  • manage-outgoing-integrations
  • manage-own-outgoing-integrations

The endpoint returns the integration history based on the user permissions.

Changelog

Version Description
1.1.0 Separate permissions in incoming and outgoing.
0.53.0 Added
Header parameters
X-Auth-Token
stringRequired

The authorization token of the user.

Example9HqLlyZOugD_0YdwAJF8V47U3QHXSq
X-User-Id
stringRequired

The user ID of the user.

ExampleaobEdbYhXfu5hkeqG
Query parameters
id
stringRequired

The integration ID.

ExamplenvdQuJQ6tE9HRFBzd
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example50
sort

List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}. Refer to the official documentation to learn more.

query

This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" } }. Refer to the official documentation to learn more.

fields
string

This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }. Refer to the official documentation to learn more.

Responses
200
Example 1
{
  "history": [],
  "offset": 0,
  "items": 0,
  "total": 0,
  "success": true
}
Expand All
object
history
Array of object
object
offset
integer
items
integer
total
integer
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'id' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string