Search

Search and retrieve Collections with pagination. Use the total_collections and limit to calculate offset to paginate.

REQUEST JSON

The request payload JSON keys are as below. Although all parameters are optional, atleast one parameter must be passed to get useful results. We suggest sending { "sort_by": ["last_update DESC"] }

Parameter	Type	Description
`keyword`	string	(optional) Keyword to search with. Keyword will match any word in Collection `name`. Defaults to empty string (equivalent to `*` wildcard)
`private_only`	boolean	(optional) `true` if only private collections should be returned. Defaults to `false`
`last_update_range`	JSON	(optional) Like `{"start": "2022-03-18T01:01:01Z", "end": "2022-04-24T01:01:01Z"}` where the dates are ISO 8601 datetime format values
`sort_by`	JSON	(optional) Example: `["group_access ASC", "name ASC", "last_update DESC"]` where `group_access`,`name`, `last_update` are the only allowed sort fields. `ASC`is for ascending natural sort order,`DESC` is for descending natural sort order. To sort by `group_access`, then `name` and then by `last_update`, list them in sequence as in the example above.
`offset`	integer	(optional) Offset for paging. Defaults to `0`. If `limit` is 30, to retrieve second page, set `offset` to `30`, for third page set `offset` to `60`, etc
`limit`	integer	(optional) Page limit. Defaults to `30`. Maximum is `30`.

HTTP RESPONSE

Same as /api/v1/collections response.