Get List of Integrations

Print
Dark
Light
PDF

Get List of Integrations

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/integrations.list

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 integrations based on the user permissions.

Changelog

Version	Description
7.0.0	Added `name` and `type` query parameters for filtering.
1.1.0	Separate permissions in incoming and outgoing.
0.49.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

offset

integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.

Example50

count

integer

The number of items to return.

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}

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" } }

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 }

name

string

Filter list by the name of the integration.

Exampletest

type

string

Filter list by the type of the integration. It can be webhook-outgoing or webhook-incoming.

Examplewebhook-incoming

Responses

200

Success Example

{
  "integrations": [
    {
      "_id": "WMQDChpnYTRmFre9h",
      "enabled": true,
      "username": "rocket.cat",
      "alias": "Guggy",
      "avatar": "https://image.crisp.im/avatar/website/17651a90-e082-43f6-b308-957cea6e323c/128",
      "name": "Guggy",
      "triggerWords": [
        "!guggy",
        "guggy",
        "gif+"
      ],
      "urls": [
        "http://text2gif.guggy.com/guggify"
      ],
      "token": "aobEdbYhXfu5hkeqG",
      "script": "...",
      "scriptEnabled": true,
      "impersonateUser": false,
      "scriptCompiled": "...",
      "scriptError": null,
      "type": "webhook-outgoing",
      "userId": "rocket.cat",
      "channel": [],
      "_createdAt": "2017-01-05T17:06:05.660Z",
      "_createdBy": {
        "username": "graywolf336",
        "_id": "R4jgcQaQhvvK6K3iY"
      },
      "_updatedAt": "2017-01-05T17:06:05.660Z"
    },
    {
      "_id": "3aazpZ2WzoBP8msi9",
      "type": "webhook-outgoing",
      "name": "Testing via REST API",
      "enabled": false,
      "username": "rocket.cat",
      "urls": [
        "http://text2gif.guggy.com/guggify"
      ],
      "scriptEnabled": false,
      "userId": "rocket.cat",
      "channel": [],
      "_createdAt": "2017-01-06T13:23:46.018Z",
      "_createdBy": {
        "username": "graywolf336",
        "_id": "R4jgcQaQhvvK6K3iY"
      },
      "_updatedAt": "2017-01-06T13:23:46.018Z"
    }
  ],
  "offset": 0,
  "items": 2,
  "total": 2,
  "success": true
}

Expand All

object

integrations

Array of object

object

_id

string

enabled

boolean

username

string

alias

string

avatar

string

name

string

triggerWords

Array of string

string

urls

Array of string

string

token

string

script

string

scriptEnabled

boolean

impersonateUser

boolean

scriptCompiled

string

scriptError

string

type

string

userId

string

channel

Array of object

object

_createdAt

string

_createdBy

object

username

string

_id

string

_updatedAt

string

offset

integer

items

integer

total

integer

success

boolean

401

Unauthorized

Authorization Error

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

object

status

string

message

string

Was this article helpful?

What's Next

Update Integration