List content on the specified project. To learn more about content, read Content and sources.
Listing, Sorting and Filtering Content
This endpoint returns the list of content in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby
query parameter. Specify a field name, and optionally asc
or desc
.
Sorting is valid on the following fields: metadata/name
Filtering
There are two ways to filter the set of returned content from this endpoint - the first is to use the $filter
query parameter, the second is to use the
$label_key
and $label
query parameters.
$filter
allows for content to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: metadata/name
$label_key
and $label
are specific to querying content based on their labels. Labels are a set of key-value pairs that can be used to identify content with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of content.
Examples:
?$top=10
- Returns only the first 10 content from the list.
?$orderby=name desc
- Sorts content by name in descending order.
?$filter=name eq 'descriptive name'
- Returns content that match the provided name.
?$orderby=properties/created desc
- Sorts content by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z
- Returns content created after January 1, 2021.
?$label=studio=paravalley
- Returns content with the label studio
set to paravalley
.
?$label=release-date~2023
- Returns content with the label release-date
set to a value that contains 2023
.
?$label_key=studio&label_key=release-date
- Returns content with any value set for the studio
label and the release-date
label.