Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Page number (1-based), when no cursor is used."
},
"sort": {
"type": "string",
"pattern": "^-?[a-z][a-z0-9_.]{0,63}$",
"description": "Sort field, '-' prefix = descending, e.g. -created_at, -updated_at, -supporters_count."
},
"query": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Search text in the suggestion title or description."
},
"state": {
"type": "array",
"items": {
"enum": [
"published",
"approved",
"closed",
"for_review",
"deleted",
"merged",
"spam",
"new",
"filtered",
"open",
"active",
"inactive"
],
"type": "string"
},
"maxItems": 12,
"minItems": 1,
"description": "Only these states, e.g. [\"approved\",\"published\"] or [\"open\"]."
},
"cursor": {
"type": "string",
"pattern": "^[\\x21-\\x7e]+$",
"maxLength": 2000,
"minLength": 1,
"description": "pagination.next_cursor from the previous page (same sort). Preferred over page."
},
"includes": {
"type": "array",
"items": {
"enum": [
"forums",
"categories",
"statuses",
"labels",
"users",
"features",
"status_updates",
"supporter_messages"
],
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"description": "Related records to sideload into `included`."
},
"per_page": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1,
"description": "Records per page (1-100, default 20)."
},
"forum_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Only suggestions in these forums."
},
"label_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Only suggestions with these labels."
},
"no_status": {
"type": "boolean",
"description": "Only suggestions without a public status."
},
"status_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Only suggestions with these public statuses (see uservoice_list_statuses)."
},
"category_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Only suggestions in these categories."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,6})?)?(Z|[+-]\\d{2}:?\\d{2})?)?$",
"description": "Only suggestions created after this time."
},
"updated_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,6})?)?(Z|[+-]\\d{2}:?\\d{2})?)?$",
"description": "Only records updated after this time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,6})?)?(Z|[+-]\\d{2}:?\\d{2})?)?$",
"description": "Only suggestions created before this time."
},
"updated_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,6})?)?(Z|[+-]\\d{2}:?\\d{2})?)?$",
"description": "Only records updated before this time."
}
}
}