Raw schema
{
"type": "object",
"properties": {
"entity": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$",
"description": "APIv4 entity name, e.g. Campaign."
},
"select": {
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}([.][A-Za-z_][A-Za-z0-9_]{0,63}){0,3}(:[a-z_]{1,16})?$"
},
"description": "Fields to return."
},
"where": {
"description": "Filters, all of which must match.",
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}([.][A-Za-z_][A-Za-z0-9_]{0,63}){0,3}(:[a-z_]{1,16})?$"
},
"op": {
"type": "string",
"enum": [
"=",
"!=",
"<>",
"<",
">",
"<=",
">=",
"LIKE",
"NOT LIKE",
"IN",
"NOT IN",
"BETWEEN",
"NOT BETWEEN",
"CONTAINS",
"IS NULL",
"IS NOT NULL",
"IS EMPTY",
"IS NOT EMPTY"
],
"description": "Operator. IS NULL, IS NOT NULL, IS EMPTY and IS NOT EMPTY take no value; IN, NOT IN and BETWEEN take a list."
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
{
"maxItems": 200,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
]
}
},
"required": [
"field",
"op"
]
}
},
"order_by": {
"description": "Sort order.",
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}([.][A-Za-z_][A-Za-z0-9_]{0,63}){0,3}(:[a-z_]{1,16})?$"
},
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"field"
]
}
},
"limit": {
"description": "Records per call, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"description": "How many records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
}
},
"required": [
"entity",
"select"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}