API documentation

The REST API of the Payload back office, read-only: every published collection is exposed without authentication, in Payload’s format (docs, totalDocs, page, totalPages…). Writing requires a session or an API key; draft content never leaves without a session. Files (images, PDF) are served under /api/<collection>/file/<name>.

Base URL: https://demo.rhanb.com/api Download the OpenAPI document (JSON) · Licence Ouverte 2.0 (Etalab open licence; fictitious demonstration data)

• GET/pagespages

  List: Pages

  The editorial pages, with their tree and their blocks.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/pages/{id}pages

  Read: Page

  Parameters

  Name	Type	Description
  id	integer

• GET/actualitesactualites

  List: News

  The published news.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/actualites/{id}actualites

  Read: News item

  Parameters

  Name	Type	Description
  id	integer

• GET/agendaagenda

  List: Events

  The events of the calendar.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/agenda/{id}agenda

  Read: Event

  Parameters

  Name	Type	Description
  id	integer

• GET/servicesservices

  List: Services

  The town services of the directory.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/services/{id}services

  Read: Town service

  Parameters

  Name	Type	Description
  id	integer

• GET/eluselus

  List: Elected officials

  The members of the town council.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/elus/{id}elus

  Read: Elected official

  Parameters

  Name	Type	Description
  id	integer

• GET/equipementsequipements

  List: Facilities

  The town’s facilities, with their position on the map.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/equipements/{id}equipements

  Read: Facility

  Parameters

  Name	Type	Description
  id	integer

• GET/demarchesdemarches

  List: Procedures

  The procedures and their steps.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/demarches/{id}demarches

  Read: Procedure

  Parameters

  Name	Type	Description
  id	integer

• GET/documentsdocuments

  List: Documents and acts

  Acts and publications; restricted documents do not appear without a session.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/documents/{id}documents

  Read: Document

  Parameters

  Name	Type	Description
  id	integer

• GET/themesthemes

  List: Themes

  The shared taxonomy.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/themes/{id}themes

  Read: Theme

  Parameters

  Name	Type	Description
  id	integer

• GET/sitessites

  List: Sites and mini-sites

  The main site and the mini-sites.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/sites/{id}sites

  Read: Site

  Parameters

  Name	Type	Description
  id	integer

• GET/mediasmedias

  List: Media library

  The media library: metadata and image sizes.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/medias/{id}medias

  Read: Media

  Parameters

  Name	Type	Description
  id	integer

• GET/redirectionsredirections

  List: Redirections

  The active redirections.

  Parameters

  Name	Type	Description
  limit	integer	Number of documents per page.
  page	integer
  sort	string	Sort field; prefixed with - for descending order (e.g. -datePublication).
  where	object	Filter, with the syntax where[field][operator]=value; operators: equals, contains, in, greater_than, less_than…
  depth	integer	Depth to which relations are resolved.
  locale	fr | en	Language of the localised fields.

• GET/redirections/{id}redirections

  Read: Redirection

  Parameters

  Name	Type	Description
  id	integer

• GET/openapi.jsonmeta

  This description

• GET/santemeta

  The back office’s health probe