Raw schema
{
"type": "object",
"properties": {
"search_text": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Text to search for."
},
"search_option": {
"description": "Where to search (default All).",
"type": "string",
"enum": [
"All",
"Creator",
"Contact",
"Subject",
"Tag",
"Type"
]
},
"folder_id": {
"description": "Only this folder; -1 or omitted = all folders.",
"type": "integer",
"minimum": -1,
"maximum": 1000000000
},
"tab_id": {
"description": "Only this tab; -1 or omitted = all tabs.",
"type": "integer",
"minimum": -1,
"maximum": 1000000000
},
"start_date": {
"description": "First day, yyyy-mm-dd. Omit with end_date to search all years.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"end_date": {
"description": "Last day, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"sort_order": {
"description": "Sort order (default CreatedDesc).",
"type": "string",
"enum": [
"CreatedDesc",
"CreatedAsc",
"ModifiedDesc",
"ModifiedAsc",
"DocumentDateDesc",
"DocumentDateAsc",
"ContactNameAsc",
"ContactNameDesc"
]
},
"number_of_records": {
"description": "Documents per call (default 100, max 500).",
"type": "integer",
"minimum": 1,
"maximum": 500
},
"start_record": {
"description": "Offset of the first document (default 0). Add numberOfRecords to page on.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
},
"offset": {
"description": "Skip this many documents of the fetched batch (default 0). A long batch is cut to fit the reply: use next_offset with the same arguments.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
},
"domain_id": {
"description": "Yuki domain id (from yuki_list_domains). Optional when the key has a single domain.",
"type": "string",
"pattern": "^[A-Za-z0-9._-]{1,64}$"
}
},
"required": [
"search_text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}