GET
/
v1
/
integrations
Get integrations
curl --request GET \
  --url https://api.novu.co/v1/integrations
[
  {
    "_id": "<string>",
    "_environmentId": "<string>",
    "_organizationId": "<string>",
    "name": "<string>",
    "identifier": "<string>",
    "providerId": "<string>",
    "channel": "in_app",
    "credentials": {
      "apiKey": "<string>",
      "user": "<string>",
      "secretKey": "<string>",
      "domain": "<string>",
      "password": "<string>",
      "host": "<string>",
      "port": "<string>",
      "secure": true,
      "region": "<string>",
      "accountSid": "<string>",
      "messageProfileId": "<string>",
      "token": "<string>",
      "from": "<string>",
      "senderName": "<string>",
      "projectName": "<string>",
      "applicationId": "<string>",
      "clientId": "<string>",
      "requireTls": true,
      "ignoreTls": true,
      "tlsOptions": {},
      "baseUrl": "<string>",
      "webhookUrl": "<string>",
      "redirectUrl": "<string>",
      "hmac": true,
      "serviceAccount": "<string>",
      "ipPoolName": "<string>",
      "apiKeyRequestHeader": "<string>",
      "secretKeyRequestHeader": "<string>",
      "idPath": "<string>",
      "datePath": "<string>",
      "apiToken": "<string>",
      "authenticateByToken": true,
      "authenticationTokenKey": "<string>",
      "instanceId": "<string>",
      "alertUid": "<string>",
      "title": "<string>",
      "imageUrl": "<string>",
      "state": "<string>",
      "externalLink": "<string>"
    },
    "active": true,
    "deleted": true,
    "deletedAt": "<string>",
    "deletedBy": "<string>",
    "primary": true,
    "conditions": [
      {
        "isNegated": true,
        "type": "BOOLEAN",
        "value": "AND",
        "children": [
          {
            "field": "<string>",
            "value": "<string>",
            "operator": "LARGER",
            "on": "subscriber"
          }
        ]
      }
    ]
  }
]

Response

The list of integrations belonging to the organization that are successfully returned.

​
_environmentId
string
required
​
_organizationId
string
required
​
name
string
required
​
identifier
string
required
​
providerId
string
required
​
channel
enum<string>
required
Available options:
in_app,
email,
sms,
chat,
push
​
credentials
object
required
​
active
boolean
required
​
deleted
boolean
required
​
deletedAt
string
required
​
deletedBy
string
required
​
primary
boolean
required
​
_id
string
​
conditions
object[]