Locations

Get a single location by external id

Changed on Sep 23, 2026

Returns a single location by its external identifier within the given agenda - the (key, value) pair an ExtId mapping carries in the location's extIds. Use this when you sync from your own system and hold its id rather than the OpenAgenda uid. Resolves to the same Location as the by-uid get.

get/agendas/{agendaUid}/locations/ext/{extKey}/{extId}

Request

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

extKeystring required

Name of the external system/source the identifier belongs to (the key of an ExtId mapping carried on the resource — an event or a location).

extIdstring required

The resource's identifier within that external system (the value of an ExtId mapping carried in the resource's extIds). Percent-encode reserved characters.

Response

The location.

uidinteger required

slugstring required

setUidinteger nullable required

Uid of the shared location set this location belongs to, or null when it belongs to a single agenda's own pool.

namestring required

addressstring nullable required

citystring nullable required

districtstring nullable required

regionstring nullable required

departmentstring nullable required

adminLevel3string nullable required

adminLevel5string nullable required

postalCodestring nullable required

inseestring nullable required

INSEE code of the French municipality, when known.

countryCodestring nullable required

ISO 3166-1 alpha-2 country code.

latitudenumber double required

longitudenumber double required

timezonestring nullable required

IANA time zone of the location.

descriptionLocalizedString required

A string localized per language, keyed by ISO 639-1 code (e.g. fr, en).

accessLocalizedString required

A string localized per language, keyed by ISO 639-1 code (e.g. fr, en).

imageCreditsstring nullable required

websitestring nullable required

emailstring nullable required

phonestring nullable required

linksstring[] required

siretstring nullable required

SIRET number (French establishment id) of the location's operator, when provided.

verifiedboolean required

Whether the location was verified by an agenda moderator.

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "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"
}

Changes

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
  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 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 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 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
Sep 22, 2026550dac9bcc88 Revision changes
- breaking
  the response's body type changed from no type to object for status
- info
  removed from the response body oneOf list for the response status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  removed the bad_request enum value from the / response property for the response status
- info
  removed the bad_request enum value from the / response property for the response status
- info
  removed the forbidden enum value from the / response property for the response status
- info
  removed the forbidden enum value from the / response property for the response status
- info
  removed the insufficient_scope enum value from the / response property for the response status
- info
  removed the insufficient_scope enum value from the / response property for the response status
- info
  removed the not_found enum value from the / response property for the response status
- info
  removed the not_found enum value from the / response property for the response status
- info
  removed the read_only_credential enum value from the / response property for the response status
- info
  removed the read_only_credential enum value from the / response property for the response status
- info
  removed the service_unavailable enum value from the / response property for the response status
- info
  removed the service_unavailable enum value from the / response property for the response status
- info
  removed the unauthorized enum value from the / response property for the response status
- info
  removed the unauthorized enum value from the / response property for the response status
- info
  added the required property to the response with the status

Operation history