Get Latest Publications
Required scope:
public-api:read
Description
The response is an array of objects with 3 possible top-level properties:
- systemdata
- metadata
- content
Use Cases:
- Bulk export of data, e.g. a specific contentType
Endpoint
GET api/v1/documents/latestPublications
Parameters
Name | Type | Notes |
---|---|---|
?fields | string | Filters which (comma separated) properties are included in the response. Defaults to systemdata,metadata,content (no renditions). |
?limit | integer | A limit for how much published documents to retrieve. Defaults to 100. Max. 100. |
?offset | integer | An offset into the query. Useful when getting more than 100 results (pagination) |
?reverse | boolean | Order publications in ascending order instead of the default descending order. This is useful if you want to paginate using a time based filter. |
?homepage | boolean | Return only the document labeled as homepage in the current project. |
?contentTypes | string | Comma separated list of content types to use as filter. |
?documentTypes | string | Comma separated list of document types to use as filter. Can be one of article , page , data-record . |
?id.gte | string | Filter by document id range. Supported filters: id.gte , id.gt , id.lte , id.lt .The id range filter is useful if you want to export a lot of documents. You can do many requests in parallel against the api, where you filter by the specific ranges. This query is much more flexible than an offset-based filter and works with millions of documents. Request 1: ?id.gt=0&id.lte=100 Request 2: ?id.gt=100&id.lte=200 Request 3: ?id.gt=200&id.lte=300 |
?publishedAt.gte | string | Filter by publish date range. Supported filters: publishedAt.gte , publishedAt.gt , publishedAt.lte , publishedAt.lt .Example: To retrieve all publications since a specific timestamp, use ?reverse&publishedAt.gte=2021-05-01T00:00:00.000Z |