Agendas

Returns a single agenda in its full Agenda representation. An unknown agenda uid answers 404.

get/agendas/{agendaUid}

Request

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

Path parameters

agendaUidinteger required

Numeric uid of the agenda.

Response

The agenda.

uidinteger required
slugstring required
titlestring required
descriptionstring nullable required
officialboolean required

Whether the agenda is an official one.

urlstring uri nullable required

Public website URL of the agenda, or null.

createdAtstring date-time required
updatedAtstring date-time required
officializedAtstring date-time nullable required

When the agenda was officialized, or null if it is not official.

privateboolean required

Whether the agenda is private (not publicly listed).

indexedboolean required

Whether the agenda is indexed in public search.

Example response

{
  "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,
  "url": "https://openagenda.com/festival-des-lumieres",
  "createdAt": "2024-11-04T09:12:00+01:00",
  "updatedAt": "2025-05-28T16:45:00+02:00",
  "officializedAt": "2024-11-15T10:00:00+01:00",
  "private": false,
  "indexed": true,
  "network": {
    "uid": 87,
    "title": "Ville de Lyon"
  },
  "locationSet": {
    "uid": 204,
    "title": "Lieux de Lyon"
  },
  "rights": {
    "license": {
      "id": "etalab-2.0",
      "name": "Licence Ouverte 2.0",
      "url": "https://www.data.gouv.fr/pages/legal/licences/etalab-2.0/"
    },
    "publisher": {
      "name": "Ville de Lyon",
      "url": "https://www.lyon.fr"
    }
  }
}

Changes

    • 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

    • info

      added the optional property / to the response with the 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 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 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 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 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 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 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

      removed the unauthorized enum value from the / response property for the response status