Skip to main content

List Add-ons

Retrieve every add-on of a publication you own, drafts included.

Endpoint

GET /api/v3/content/{content}/add-ons

{content} is the publication's internal ID, or any of its identifiers with id_type=external.


Query Parameters

Publication lookup

ParameterTypeDefaultDescription
id_typestringinternalinternal (publication ID) or external (identifier)

Pagination

ParameterTypeDefaultDescription
per_pageinteger100Items per page (1-500)
cursorstring-Cursor token from links.next or links.prev

Sorting

ParameterTypeDefaultDescription
sortstringstart_pageSort field. Prefix with - for descending

Allowed sort fields: start_page, created_at, updated_at

Filters

ParameterTypeDescription
filter[status]stringdraft or published
filter[type]stringarticle, audio, video, image or link

Fields Selection

ParameterTypeDescription
fieldsstringComma-separated list of fields to return

Request Examples

# All add-ons of publication 123, in reading order
curl -X GET "https://yourstore.publica.la/api/v3/content/123/add-ons" \
-H "X-User-Token: your-api-token"

# Only drafts, by external identifier
curl -X GET "https://yourstore.publica.la/api/v3/content/9789561234567/add-ons?id_type=external&filter[status]=draft" \
-H "X-User-Token: your-api-token"

# Trimmed payload
curl -X GET "https://yourstore.publica.la/api/v3/content/123/add-ons?fields=id,title,status,start_page" \
-H "X-User-Token: your-api-token"

Response

{
"data": [
{
"id": "1044",
"content_id": "123",
"title": "Interview with the author",
"pretitle": null,
"author": null,
"by_line": null,
"type": "article",
"body": "<p>…</p>",
"body_format": "html",
"image_url": null,
"image_caption": null,
"start_page": 3,
"end_page": 3,
"location_in_start_page": { "x": 25.5, "y": 40 },
"anchor": { "type": "point", "page": 3, "point": { "x": 25.5, "y": 40 } },
"status": "draft",
"created_at": "2026-08-13T14:05:00.000000Z",
"updated_at": "2026-08-13T14:05:00.000000Z"
}
],
"links": {
"next": "https://yourstore.publica.la/api/v3/content/123/add-ons?cursor=eyJ...",
"prev": null
},
"meta": {
"has_more": true
}
}
Owners see drafts

This endpoint returns add-ons in every status. Drafts are hidden from readers (web reader, apps, offline downloads), never from the owner managing them.

Errors

StatusCondition
401Missing or invalid X-User-Token
403Add-ons feature not enabled, non-administrator token, or the publication is not owned by your store
404Publication not found
422Invalid query parameter (unknown sort field, invalid filter value)
X

Graph View