Get list of collections
Required roles:
- can_read_collections
get/v1/collections/
Request
- Base URLhttps://app.iconik.io/API/assets
- Authnone declared. Required headers: App-ID, Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
per_pageinteger
The number of items for each page
pageinteger
Which page number to fetch
scrollboolean
If true passed then uses scroll pagination instead of default one
scroll_idstring
In order to get next batch of results using scroll pagination the scroll_id is required
sortstring
A comma separated list of fieldnames with order. For example - title,asc;is_root,desc
is_rootstring
Filter by is_root
statusstring
Filter by status
favoured_bystring
A user UUID who has favorited the collections
include_keyframesboolean
If false, keyframe data and presigned URLs are omitted from the response
idsstring
A comma separated list of collection IDs to filter by
Headers
App-IDstring required
Auth-Tokenstring required
Response
Returns a list of collections
Changes
No recorded changes to this operation across all 1 revision of this API.