Locations

List an agenda's locations

Changed on Sep 28, 2026

Returns a cursor-paginated list of the agenda's locations, newest first (insertion order, which can differ from createdAt). Pass the after cursor returned in pagination.after to fetch the next page, with the same filters.

When the agenda shares its locations through a location set, the whole set is listed - including locations contributed by the other agendas of the set (their setUid carries the set's uid).

Unknown or malformed filter values answer 400, with per-field context under error.errors. An unrecognized top-level query parameter is ignored.

get/agendas/{agendaUid}/locations

Request

Base URL: https://api.openagenda.com/v3
URL: https://api.openagenda.com/v3/agendas/{agendaUid}/locations
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: locations:read)

Path parameters

agendaUidinteger required

Numeric uid of the agenda.

Query parameters

afterstring

Opaque pagination cursor returned in pagination.after of the previous page. Omit it to fetch the first page.

limitinteger

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.

detailedboolean

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.

fieldsstring[]

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"
]

searchstring

Free-text search over the locations' name, address, city, region and department.

uidinteger[]

Restrict to the given location uid(s). Repeat the parameter (uid=123&uid=456) for multiple values.

keystring required

valuestring required

Match a location by an external identifier: extId[key]=<system>&extId[value]=<id>. Both parts are required.

bboxstring

Restrict to locations within a bounding box, given as west,south,east,north in decimal degrees (WGS84). Example: bbox=2.224,48.815,2.469,48.902.

gtestring date-time

ltestring date-time

Restrict by creation date, as RFC 3339 date-times: createdAt[gte]=…&createdAt[lte]=…. Date-times must carry an explicit offset (e.g. Z); a bare date (YYYY-MM-DD) is read as UTC midnight.

gtestring date-time

ltestring date-time

Restrict by last-update date, as RFC 3339 date-times: updatedAt[gte]=…&updatedAt[lte]=…. Useful for incremental sync. Date-times must carry an explicit offset (e.g. Z); a bare date (YYYY-MM-DD) is read as UTC midnight.

Response

A page of locations.

Example response

{
  "data": [
    {
      "uid": 67890,
      "slug": "chateau-des-lebres_4421007",
      "setUid": null,
      "name": "Château des Lèbres",
      "address": "Naves, 07140 Les Vans",
      "city": "Les Vans",
      "district": null,
      "region": "Auvergne-Rhône-Alpes",
      "department": "Ardèche",
      "adminLevel3": null,
      "adminLevel5": null,
      "postalCode": "07140",
      "insee": "07334",
      "countryCode": "FR",
      "latitude": 44.388303,
      "longitude": 4.105528,
      "timezone": "Europe/Paris",
      "description": {
        "fr": "Ancienne maison forte des comtes du Roure."
      },
      "access": {},
      "image": {
        "width": 1200,
        "height": 800,
        "src": "https://img.openagenda.com/u/1080x0/main/67890.full.image.jpg",
        "srcTemplate": "https://img.openagenda.com/u/{geo}/main/67890.full.image.jpg",
        "srcset": [
          {
            "width": 640,
            "url": "https://img.openagenda.com/u/640x0/main/67890.full.image.jpg"
          },
          {
            "width": 1080,
            "url": "https://img.openagenda.com/u/1080x0/main/67890.full.image.jpg"
          }
        ]
      },
      "imageCredits": null,
      "website": "http://www.domainedeslebres.com/",
      "email": null,
      "phone": "0475363414",
      "links": [
        "https://fr-fr.facebook.com/domainedeslebres/"
      ],
      "extIds": [
        {
          "key": "legacy",
          "value": "4421007"
        }
      ],
      "additionalFields": {
        "tags": [
          {
            "id": 2,
            "label": "Château, hôtel urbain, palais, manoir"
          }
        ]
      },
      "siret": null,
      "verified": true,
      "createdAt": "2017-10-30T14:21:07.000Z",
      "updatedAt": "2019-04-29T15:40:33.000Z"
    }
  ],
  "pagination": {
    "after": "eyJ1aWQiOjIzNDU2fQ",
    "limit": 20,
    "total": 342,
    "totalRelation": "exact"
  }
}

Changes

Sep 28, 2026948e1d1c57f3 Revision changes
- info
  added the optional property /////// to the response with the status
Sep 23, 2026504611f6f282 Revision changes
- breaking
  added to the response body oneOf list for the response status
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new bad_request enum value to the / response property for the response status
- warning
  added the new bad_request enum value to the / response property for the response status
- warning
  added the new bad_request enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new insufficient_scope enum value to the / response property for the response status
- warning
  added the new insufficient_scope enum value to the / response property for the response status
- warning
  added the new insufficient_scope enum value to the / response property for the response status
- warning
  added the new not_found enum value to the / response property for the response status
- warning
  added the new not_found enum value to the / response property for the response status
- warning
  added the new not_found enum value to the / response property for the response status
- warning
  added the new read_only_credential enum value to the / response property for the response status
- warning
  added the new read_only_credential enum value to the / response property for the response status
- warning
  added the new read_only_credential enum value to the / response property for the response status
- warning
  added the new service_unavailable enum value to the / response property for the response status
- warning
  added the new service_unavailable enum value to the / response property for the response status
- warning
  added the new service_unavailable enum value to the / response property for the response status
- warning
  added the new unauthorized enum value to the / response property for the response status
- warning
  added the new unauthorized enum value to the / response property for the response status
- warning
  added the new unauthorized enum value to the / response property for the response status

Operation history (4 revisions)