Raw schema
{
"type": "object",
"properties": {
"status": {
"description": "Only leads in these statuses (todo = to do, standby = waiting for a reminder date).",
"minItems": 1,
"maxItems": 5,
"type": "array",
"items": {
"type": "string",
"enum": [
"todo",
"standby",
"won",
"cancelled",
"lost"
]
}
},
"steps": {
"description": "Only leads in these pipeline steps: exact step names OR step ids (not mixed). See nocrm_list_steps.",
"anyOf": [
{
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
{
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
}
]
},
"user_id": {
"description": "Only leads owned by this user (id or email).",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"minLength": 1,
"maxLength": 200
}
]
},
"tags": {
"description": "Only leads carrying ALL of these tags.",
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"email": {
"description": "Only leads whose description or comments contain this email address.",
"type": "string",
"minLength": 3,
"maxLength": 200
},
"starred": {
"description": "true = only starred leads.",
"type": "boolean"
},
"include_unassigned": {
"description": "Also return leads that have no owner (default false).",
"type": "boolean"
},
"order": {
"description": "Sort attribute (default id).",
"type": "string",
"enum": [
"id",
"creation_date",
"last_update",
"next_action",
"sale_step",
"amount",
"probability",
"probalized_amount",
"alphabetically"
]
},
"direction": {
"description": "Sort direction (default desc).",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"date_range_type": {
"description": "Which date start_date/end_date apply to (default creation).",
"type": "string",
"enum": [
"creation",
"update",
"next_action",
"closed"
]
},
"start_date": {
"description": "From this date (yyyy-mm-dd), by date_range_type.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"end_date": {
"description": "Until this date (yyyy-mm-dd), by date_range_type.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"updated_after": {
"description": "Only leads updated on or after this date (yyyy-mm-dd). Do not combine with date_range_type.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"limit": {
"description": "Results per call, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"description": "Skip this many results (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}