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 Deals

/api/v1/developer/crm/deals

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

Access scopecrm.deals.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

lifecycleoptional · query: stringdefault: "active" · enum: ["active","archived","all"]
JSON Schema
{ "type": "string", "enum": [ "active", "archived", "all" ], "default": "active" }
statusoptional · query: stringdefault: "all" · enum: ["open","won","lost","all"]
JSON Schema
{ "type": "string", "enum": [ "open", "won", "lost", "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/deals?lifecycle=active&limit=50' \
  --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Paginated project CRM deals

application/json

object

dealsrequired

arraymaxItems: 100

Nested schema

arraymaxItems: 100

object

idrequired: stringminLength: 1 · maxLength: 160
contactIdrequired: stringminLength: 1 · maxLength: 160
organizationIdrequired: string | nullminLength: 1 · maxLength: 160
titlerequired: stringminLength: 1
tagsrequired: array
Nested schema
array
string
JSON Schema
{ "type": "string" }
JSON Schema
{ "type": "array", "items": { "type": "string" } }
pipelineIdrequired: stringminLength: 1 · maxLength: 160
stageIdrequired: stringminLength: 1 · maxLength: 160
budgetMinorrequired: integerminimum: 0
expectedCloseDaterequired: string | nullformat: "date"
statusrequired: stringenum: ["open","won","lost"]
lifecyclerequired: stringenum: ["active","archived"]
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
    },
    "organizationId": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 160
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "pipelineId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "stageId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "budgetMinor": {
      "type": "integer",
      "minimum": 0
    },
    "expectedCloseDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "won",
        "lost"
      ]
    },
    "lifecycle": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "contactId",
    "organizationId",
    "title",
    "tags",
    "pipelineId",
    "stageId",
    "budgetMinor",
    "expectedCloseDate",
    "status",
    "lifecycle",
    "createdAt",
    "updatedAt"
  ]
}

JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "contactId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "organizationId": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1,
        "maxLength": 160
      },
      "title": {
        "type": "string",
        "minLength": 1
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "pipelineId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "stageId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 160
      },
      "budgetMinor": {
        "type": "integer",
        "minimum": 0
      },
      "expectedCloseDate": {
        "type": [
          "string",
          "null"
        ],
        "format": "date"
      },
      "status": {
        "type": "string",
        "enum": [
          "open",
          "won",
          "lost"
        ]
      },
      "lifecycle": {
        "type": "string",
        "enum": [
          "active",
          "archived"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "date-time"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time"
      }
    },
    "required": [
      "id",
      "contactId",
      "organizationId",
      "title",
      "tags",
      "pipelineId",
      "stageId",
      "budgetMinor",
      "expectedCloseDate",
      "status",
      "lifecycle",
      "createdAt",
      "updatedAt"
    ]
  },
  "maxItems": 100
}

nextCursorrequired

string | null

JSON Schema

{
  "type": "object",
  "properties": {
    "deals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "contactId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "organizationId": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 160
          },
          "title": {
            "type": "string",
            "minLength": 1
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "pipelineId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "stageId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "budgetMinor": {
            "type": "integer",
            "minimum": 0
          },
          "expectedCloseDate": {
            "type": [
              "string",
              "null"
            ],
            "format": "date"
          },
          "status": {
            "type": "string",
            "enum": [
              "open",
              "won",
              "lost"
            ]
          },
          "lifecycle": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "contactId",
          "organizationId",
          "title",
          "tags",
          "pipelineId",
          "stageId",
          "budgetMinor",
          "expectedCloseDate",
          "status",
          "lifecycle",
          "createdAt",
          "updatedAt"
        ]
      },
      "maxItems": 100
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "deals",
    "nextCursor"
  ],
  "$ref": "#/components/schemas/DeveloperCrmDealListResponse"
}

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