Search

GET {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/search/items?q=[string]

Allows searching for contents by either ZUID, meta text values or path-related values.

List of ZUID typees that will do the search into for 'q' value:

• Content Models
• Users
• Items

List of meta and path keys that will do the search into if 'q' value is not a ZUID:

• URL Path Part
• Full Path
• Navigation Link Text
• Meta Title
• Meta Description
• Meta Keywords

Request Params

• Allowed values: A number between 1 to 1000

• Default value: 100 | | order | string | | What to order results by

• Allowed values: created, modified, label | | dir | string | | Required if order key is provided. Determines the sorting direction in either ascending or descending.

• Allowed values: asc, desc

• Default value: desc | | start_date | string | | Aceptable date formats are yyyy/mm/dd (2022/01/31) and mm/dd/yyyy (01/31/2022). You can also use dashes (01-25-2022) as a separator. More info here: https://github.com/araddon/dateparse

Note: The filtering will be based on the item's updateAt value. | | end_date | string | | Aceptable date formats are yyyy/mm/dd (2022/01/31) and mm/dd/yyyy (01/31/2022). You can also use dashes (01-25-2022) as a separator. More info here: https://github.com/araddon/dateparse

Note: The filtering will be based on the item's updateAt value. | | q | string | | [string] Required. Can be either a text string that refers to meta text values, path-related key values, or a ZUID of type content model, user or item. |

RESPONSES

status: OK

{"_meta":{"timestamp":"2021-08-25T22:34:24.607461725Z","totalResults":0,"start":0,"offset":0,"limit":0},"data":[]}