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 Crm Clients

/api/v1/developer/crm/clients

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

Access scopecrm.clients.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

statusoptional · query: stringenum: ["active","archived","all"]
JSON Schema
{ "type": "string", "enum": [ "active", "archived", "all" ] }
limitoptional · query: integerminimum: 1 · maximum: 100 · default: 50
JSON Schema
{ "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }
cursoroptional · query: stringminLength: 1 · maxLength: 512
JSON Schema
{ "type": "string", "minLength": 1, "maxLength": 512 }

Request examples

curl --request GET \
  'https://YOUR_NOVA_HOST/api/v1/developer/crm/clients?status=active&limit=50' \
  --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Paginated project CRM clients

application/json

object

clientsrequired

arraymaxItems: 100

Nested schema

arraymaxItems: 100

object

idrequired: stringminLength: 1 · maxLength: 160
displayNamerequired: stringminLength: 1
statusrequired: stringenum: ["active","archived"]
createdAtrequired: stringformat: "date-time"
updatedAtrequired: stringformat: "date-time"
channelsrequired: array
Nested schema
array
object
JSON Schema
{ "type": "object", "properties": { "providerType": { "type": "string", "minLength": 1 }, "externalId": { "type": "string", "minLength": 1 }, "displayName": { "type": "string", "minLength": 1 } }, "required": [ "providerType", "externalId", "displayName" ] }
JSON Schema
{ "type": "array", "items": { "type": "object", "properties": { "providerType": { "type": "string", "minLength": 1 }, "externalId": { "type": "string", "minLength": 1 }, "displayName": { "type": "string", "minLength": 1 } }, "required": [ "providerType", "externalId", "displayName" ] } }

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "displayName": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "providerType": {
            "type": "string",
            "minLength": 1
          },
          "externalId": {
            "type": "string",
            "minLength": 1
          },
          "displayName": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "providerType",
          "externalId",
          "displayName"
        ]
      }
    }
  },
  "required": [
    "id",
    "displayName",
    "status",
    "createdAt",
    "updatedAt",
    "channels"
  ]
}

JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "displayName": {
        "type": "string",
        "minLength": 1
      },
      "status": {
        "type": "string",
        "enum": [
          "active",
          "archived"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "date-time"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time"
      },
      "channels": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "providerType": {
              "type": "string",
              "minLength": 1
            },
            "externalId": {
              "type": "string",
              "minLength": 1
            },
            "displayName": {
              "type": "string",
              "minLength": 1
            }
          },
          "required": [
            "providerType",
            "externalId",
            "displayName"
          ]
        }
      }
    },
    "required": [
      "id",
      "displayName",
      "status",
      "createdAt",
      "updatedAt",
      "channels"
    ]
  },
  "maxItems": 100
}

nextCursorrequired

string | null

JSON Schema

{
  "type": "object",
  "properties": {
    "clients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "displayName": {
            "type": "string",
            "minLength": 1
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "providerType": {
                  "type": "string",
                  "minLength": 1
                },
                "externalId": {
                  "type": "string",
                  "minLength": 1
                },
                "displayName": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "required": [
                "providerType",
                "externalId",
                "displayName"
              ]
            }
          }
        },
        "required": [
          "id",
          "displayName",
          "status",
          "createdAt",
          "updatedAt",
          "channels"
        ]
      },
      "maxItems": 100
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "clients",
    "nextCursor"
  ],
  "$ref": "#/components/schemas/DeveloperCrmClientListResponse"
}

400 Invalid pagination 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"
  ]
}

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