Sign in
Events

Event form schema of an agenda

Changed on

Returns the agenda's merged event form schema — the dynamic contract the events of this agenda follow. It merges the platform's native event fields with the network's and the agenda's own declarations: an agenda can add its own additional fields and override natives (make one required, restrict its options, relabel it). This is the same schema the OpenAgenda UI uses to build the event form: use it to know which fields exist, which are required and what their options are - e.g. to build payloads for the event write operations, to interpret additionalFields on events, or to discover the agenda-specific facets of the facets endpoint.

Descriptors are scoped to your read access: a field whose read access levels exclude the caller (e.g. a moderator-only field) is omitted from fields, so a public caller sees only the public fields. Native fields the write operations do not take (the event's uid, slug, timestamps...) are omitted too, and status is listed only on an agenda that accepts it.

get/agendas/{agendaUid}/events/schema

Request

  • Base URL: https://api.openagenda.com/v3
  • URL: https://api.openagenda.com/v3/agendas/{agendaUid}/events/schema
  • 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 merged event form schema.

Example response

{
  "fields": [
    {
      "field": "thematique",
      "path": "additionalFields.thematique",
      "fieldType": "radio",
      "label": {
        "fr": "Thématique",
        "en": "Theme"
      },
      "schemaId": 10522,
      "schemaType": "agenda",
      "options": [
        {
          "id": 42,
          "value": "concert",
          "label": {
            "fr": "Concert"
          }
        }
      ]
    }
  ]
}

Changes

  • 3b83c4915e3cRevision changes
    • warning

      added the new reader enum value to the /// response property for the response status

    • warning

      added the new reader enum value to the /// response property for the response status

  • 7d56a9aede3eRevision changes
    • warning

      added the new administrator enum value to the /// response property for the response status

    • warning

      added the new administrator enum value to the /// response property for the response status

    • warning

      added the new contributor enum value to the /// response property for the response status

    • warning

      added the new contributor enum value to the /// response property for the response status

    • warning

      added the new internal enum value to the /// response property for the response status

    • warning

      added the new internal enum value to the /// response property for the response status

    • warning

      added the new moderator enum value to the /// response property for the response status

    • warning

      added the new moderator enum value to the /// response property for the response status

    • warning

      added the new public enum value to the /// response property for the response status

    • warning

      added the new public enum value to the /// response property for the response status

    • warning

      added the new system enum value to the /// response property for the response status

    • warning

      added the new system enum value to the /// response property for the response status