API reference
DEVELOPER PLATFORM · v1

An API you can build with

CRM, campaigns, analytics and integrations. Exact contracts, practical examples and signed webhooks.

Download OpenAPI

Private preview: use a project API key. Public SLA and support windows have not been established yet.

GET

List Developer Integration Installations

/api/v1/developer/integrations

Use the access scope below. The generated schemas specify the exact request and responses.

Access scopeintegrations.installations.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

statusoptional · query

stringenum: ["current","active","paused","disconnected","all"]

JSON Schema
{
  "type": "string",
  "enum": [
    "current",
    "active",
    "paused",
    "disconnected",
    "all"
  ]
}
definitionCodeoptional · query

stringpattern: "^[a-z][a-z0-9_-]*$" · minLength: 1 · maxLength: 80

JSON Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 80,
  "pattern": "^[a-z][a-z0-9_-]*$"
}
limitoptional · query

integerminimum: 1 · maximum: 100

JSON Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100
}
cursoroptional · query

stringminLength: 1 · maxLength: 2048

JSON Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 2048
}

Request examples

curl --request GET   'https://YOUR_NOVA_HOST/api/v1/developer/integrations?status=current&limit=50'   --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Paginated project integration installations
application/json

object

installationsrequired
array
Nested schema

array

object

idrequired
stringminLength: 1 · maxLength: 160
definitionCoderequired
stringminLength: 1 · maxLength: 80
definitionVersionrequired
integerexclusiveMinimum: 0
displayNamerequired
stringminLength: 1 · maxLength: 80
statusrequired
stringenum: ["active","paused","disconnected"]
healthrequired
stringenum: ["pending","healthy","attention"]
configVersionrequired
integerexclusiveMinimum: 0
createdAtrequired
stringformat: "date-time"
updatedAtrequired
stringformat: "date-time"
disconnectedAtrequired
string | nullformat: "date-time"
JSON Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "definitionCode": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "definitionVersion": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "displayName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused",
        "disconnected"
      ]
    },
    "health": {
      "type": "string",
      "enum": [
        "pending",
        "healthy",
        "attention"
      ]
    },
    "configVersion": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "disconnectedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "definitionCode",
    "definitionVersion",
    "displayName",
    "status",
    "health",
    "configVersion",
    "createdAt",
    "updatedAt",
    "disconnectedAt"
  ],
  "additionalProperties": false
}
JSON Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "definitionCode": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "definitionVersion": {
        "type": "integer",
        "exclusiveMinimum": 0
      },
      "displayName": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "status": {
        "type": "string",
        "enum": [
          "active",
          "paused",
          "disconnected"
        ]
      },
      "health": {
        "type": "string",
        "enum": [
          "pending",
          "healthy",
          "attention"
        ]
      },
      "configVersion": {
        "type": "integer",
        "exclusiveMinimum": 0
      },
      "createdAt": {
        "type": "string",
        "format": "date-time"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time"
      },
      "disconnectedAt": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time"
      }
    },
    "required": [
      "id",
      "definitionCode",
      "definitionVersion",
      "displayName",
      "status",
      "health",
      "configVersion",
      "createdAt",
      "updatedAt",
      "disconnectedAt"
    ],
    "additionalProperties": false
  }
}
nextCursorrequired
string | null
JSON Schema
{
  "type": "object",
  "properties": {
    "installations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "definitionCode": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "definitionVersion": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "displayName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "disconnected"
            ]
          },
          "health": {
            "type": "string",
            "enum": [
              "pending",
              "healthy",
              "attention"
            ]
          },
          "configVersion": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "disconnectedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "definitionCode",
          "definitionVersion",
          "displayName",
          "status",
          "health",
          "configVersion",
          "createdAt",
          "updatedAt",
          "disconnectedAt"
        ],
        "additionalProperties": false
      }
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "installations",
    "nextCursor"
  ],
  "additionalProperties": false,
  "$ref": "#/components/schemas/DeveloperIntegrationInstallationPageResponse"
}
400 Invalid installation discovery request
application/problem+json

object

type
stringformat: "uri" · default: "about:blank"
titlerequired
string
statusrequired
integerminimum: 100 · maximum: 599
detail
string
instance
string
errors
object
JSON Schema
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}
401 Invalid developer credential
application/problem+json

object

type
stringformat: "uri" · default: "about:blank"
titlerequired
string
statusrequired
integerminimum: 100 · maximum: 599
detail
string
instance
string
errors
object
JSON Schema
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}
403 Integration discovery access unavailable
application/problem+json

object

type
stringformat: "uri" · default: "about:blank"
titlerequired
string
statusrequired
integerminimum: 100 · maximum: 599
detail
string
instance
string
errors
object
JSON Schema
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}
429 Developer API rate limit exceeded
application/problem+json

object

type
stringformat: "uri" · default: "about:blank"
titlerequired
string
statusrequired
integerminimum: 100 · maximum: 599
detail
string
instance
string
errors
object
JSON Schema
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}
503 Developer API rate limiter unavailable
application/problem+json

object

type
stringformat: "uri" · default: "about:blank"
titlerequired
string
statusrequired
integerminimum: 100 · maximum: 599
detail
string
instance
string
errors
object
JSON Schema
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}