List agendas
Changed onReturns a cursor-paginated list of agendas. Pass the after cursor returned in pagination.after to fetch the next page, with the same filters. Private agendas and agendas not indexed in public search are absent from this list.
Unknown or malformed filter values answer 400, with per-field context under error.errors. An unrecognized top-level query parameter is ignored.
Request
- Base URL: https://api.openagenda.com/v3
- URL: https://api.openagenda.com/v3/agendas
- Auth: one of:
- HTTP bearer
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://openagenda.com/api/auth/oauth2/authorize, token URL https://openagenda.com/api/auth/oauth2/token, scopes: agendas:read)
Query parameters
Opaque pagination cursor returned in pagination.after of the previous page. Omit it to fetch the first page.
Maximum number of items to return per page. An out-of-range or non-integer value is rejected with 400, never clamped; use the after cursor to page further.
When true, each item in data is returned in its detailed representation, including the detailed-only fields. When false (the default), items are the lighter summary representation.
Comma-separated list of fields to keep on each data item, to shrink the payload of large pages. When set, it selects the response shape directly over the resource's full field set, so detailed does not apply (it only governs the default shape when fields is omitted) and fields wins if both are given. uid is always returned. Each resource takes the names its own data item declares, and a dotted path descends one segment per level: on an event, location.name or timings.begin. An unknown top-level field is rejected with 400, and so is an unknown sub-field under a closed object (location.zzz); under an open container - an additionalFields custom-field bag, on the resources that carry one, or a localized text map - any sub-key is accepted and yields nothing when absent (additionalFields.myField). Response schemas stay complete, so a generated client still types the omitted fields as present — read them as optional on this path.
[ "uid", "slug" ]
Full-text search across agenda title and description. Wrap the value in double quotes for an exact phrase match.
Sort order. When omitted, results are ranked by relevance if search is set, otherwise by createdAt descending. Set recentlyAddedEvents.desc to surface the agendas with the most recent activity first.
Restrict to these agenda uids. Repeat the parameter for multiple values.
Restrict to these agenda slugs. Repeat the parameter for multiple values.
Restrict to official agendas (true) or to non-official agendas (false). Omit to return both.
Response
A page of agendas.
Example response
{
"data": [
{
"uid": 12345,
"slug": "festival-des-lumieres",
"title": "Festival des Lumières",
"description": "La programmation officielle du Festival des Lumières.",
"image": {
"width": 1400,
"height": 900,
"src": "https://img.openagenda.com/u/1080x0/main/12345.full.image.jpg",
"srcTemplate": "https://img.openagenda.com/u/{geo}/main/12345.full.image.jpg",
"srcset": [
{
"width": 640,
"url": "https://img.openagenda.com/u/640x0/main/12345.full.image.jpg"
},
{
"width": 1080,
"url": "https://img.openagenda.com/u/1080x0/main/12345.full.image.jpg"
}
]
},
"official": true
}
],
"pagination": {
"after": "eyJ1aWQiOjIzNDU2fQ",
"limit": 20,
"total": 342,
"totalRelation": "exact"
}
}Changes
- info
added the optional property
///////to the response with the status
- info
- warning
removed the optional property
///////from the response with the status
- warning