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 Tasks

/api/v1/developer/crm/tasks

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

Access scopecrm.tasks.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

statusoptional · query: stringdefault: "all" · enum: ["open","done","all"]
JSON Schema
{ "type": "string", "enum": [ "open", "done", "all" ], "default": "all" }
dueoptional · query: stringdefault: "all" · enum: ["overdue","upcoming","none","all"]
JSON Schema
{ "type": "string", "enum": [ "overdue", "upcoming", "none", "all" ], "default": "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/tasks?status=open&due=upcoming' \
  --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Paginated project CRM tasks

application/json

object

tasksrequired

arraymaxItems: 100

Nested schema

arraymaxItems: 100

object

idrequired: stringminLength: 1 · maxLength: 160
contactIdrequired: stringminLength: 1 · maxLength: 160
dealIdrequired: string | nullminLength: 1 · maxLength: 160
dealTitlerequired: string | nullminLength: 1
titlerequired: stringminLength: 1
dueAtrequired: string | nullformat: "date-time"
priorityrequired: stringenum: ["normal","high"]
statusrequired: stringenum: ["open","in_progress","done"]
createdAtrequired: stringformat: "date-time"
updatedAtrequired: stringformat: "date-time"

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "contactId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "dealId": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 160
    },
    "dealTitle": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "dueAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "priority": {
      "type": "string",
      "enum": [
        "normal",
        "high"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "in_progress",
        "done"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "contactId",
    "dealId",
    "dealTitle",
    "title",
    "dueAt",
    "priority",
    "status",
    "createdAt",
    "updatedAt"
  ]
}

JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "contactId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "dealId": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1,
        "maxLength": 160
      },
      "dealTitle": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1
      },
      "title": {
        "type": "string",
        "minLength": 1
      },
      "dueAt": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time"
      },
      "priority": {
        "type": "string",
        "enum": [
          "normal",
          "high"
        ]
      },
      "status": {
        "type": "string",
        "enum": [
          "open",
          "in_progress",
          "done"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "date-time"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time"
      }
    },
    "required": [
      "id",
      "contactId",
      "dealId",
      "dealTitle",
      "title",
      "dueAt",
      "priority",
      "status",
      "createdAt",
      "updatedAt"
    ]
  },
  "maxItems": 100
}

nextCursorrequired

string | null

JSON Schema

{
  "type": "object",
  "properties": {
    "tasks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "contactId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "dealId": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 160
          },
          "dealTitle": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "dueAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "priority": {
            "type": "string",
            "enum": [
              "normal",
              "high"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "in_progress",
              "done"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "contactId",
          "dealId",
          "dealTitle",
          "title",
          "dueAt",
          "priority",
          "status",
          "createdAt",
          "updatedAt"
        ]
      },
      "maxItems": 100
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "tasks",
    "nextCursor"
  ],
  "$ref": "#/components/schemas/DeveloperCrmTaskListResponse"
}

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