Raw schema
{
"type": "object",
"properties": {
"resource": {
"type": "string",
"enum": [
"accounts",
"donations",
"activities",
"events"
],
"description": "Which record type to search."
},
"search_fields": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "A search field name, e.g. 'Email' or 'Donation Date'."
},
"operator": {
"type": "string",
"enum": [
"EQUAL",
"NOT_EQUAL",
"BLANK",
"NOT_BLANK",
"LESS_THAN",
"GREATER_THAN",
"LESS_AND_EQUAL",
"GREATER_AND_EQUAL",
"IN_RANGE",
"NOT_IN_RANGE",
"CONTAIN",
"NOT_CONTAIN"
],
"description": "Comparison operator. BLANK/NOT_BLANK take no value."
},
"value": {
"description": "The value to compare against.",
"type": "string"
},
"value_list": {
"description": "A list of values, for IN_RANGE / NOT_IN_RANGE.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"field",
"operator"
]
},
"description": "Filter criteria, ANDed together. Neon requires at least one."
},
"output_fields": {
"minItems": 1,
"maxItems": 300,
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
]
},
"description": "Columns to return: standard field names (strings) and/or custom-field ids (integers). Max 300."
},
"current_page": {
"description": "0-based page number (Neon pages start at 0). Default 0.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"page_size": {
"description": "Results per page.",
"type": "integer",
"minimum": 1,
"maximum": 500
},
"sort_column": {
"description": "Output field name to sort by โ it must also appear in output_fields.",
"type": "string"
},
"sort_direction": {
"description": "Sort direction.",
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"resource",
"search_fields",
"output_fields"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}