How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

La Poste Open Data v1

Gateway over La Poste's open datasets - postal codes (hexasmal), contact points, post-office opening hours, services and accessibility, street letterboxes, self-service machines and new communes. Fronted through the Okapi gateway and served by the Data Fair instance at data.laposte.fr, which publishes its own OpenAPI 3.1 and an RFC 9727 /.well-known/api-catalog.

This API exposes 65 operations across 44 paths, organized into 6 resource areas, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 6.17.2.

Requests are made against a single base URL, https://data.laposte.fr/data-fair/api/v1.

65 operations 44 paths 5 schemas 7 DELETE38 GET4 PATCH11 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6.17.2
Base URL
https://api.laposte.fr/opendata/v1
Authentication
API Key, API Key
Contact
Terms of Service
Resource Areas
6

Authentication & Security 2

La Poste Open Data v1 declares 2 security schemes for authenticating requests. An API key is passed in the header as x-apiKey (apiKey). An API key is passed in the cookie as id_token (sdCookie). By default, every request must be authenticated.

Paths & Operations 65

Across 44 paths, the API surfaces 65 operations — 7 DELETE, 38 GET, 4 PATCH, 11 POST, 5 PUT. They span 6 resource areas: Administration, Jeux de données (JDD), JDD / Métadonnées, JDD / Données, Applications, JDD / Éditable. Each is listed below with its method, path, parameters, and response codes.

Administration 3
GET
/ping
Obtenir l'état de santé du service
ping → 200500
GET
/api-docs.json
Obtenir la documentation OpenAPI
getApiDoc → 200
GET
/vocabulary
Lister les concepts
getVocabulary → 200
Jeux de données (JDD) 2
GET
/datasets
Lister les jeux de données
listDatasets 18 params → 200400401403404
POST
/datasets
Créer un jeu de données
postDataset body → 201400401403413
JDD / Métadonnées 17
PUT
/datasets/{id}
Créer ou mettre à jour un jeu de données
putDataset 1 param body → 200201400401403413
GET
/datasets/{id}
Lire les informations
readDescription 1 param → 200401403404
PATCH
/datasets/{id}
Modifier le jeu de données
writeDescription 1 param body → 200400401403404
DELETE
/datasets/{id}
Supprimer le jeu de données
delete 1 param → 204401403404
GET
/datasets/{id}/schema
Lire le schéma
readSchema 7 params → 200401403404
GET
/datasets/{id}/safe-schema
Lire le schéma réduit
readSafeSchema 7 params → 200401403404
GET
/datasets/{id}/api-docs.json
Obtenir la documentation OpenAPI
readApiDoc 1 param → 200401403404
GET
/datasets/{id}/private-api-docs.json
Obtenir la documentation privée OpenAPI
readPrivateApiDoc 1 param → 200401403404
GET
/datasets/{id}/thumbnail
Récupérer la vignette
readThumbnail 1 param → 200401403404
POST
/datasets/{id}/metadata-attachments
Charger une pièce jointe
postMetadataAttachment 1 param body → 200400401403404413
GET
/datasets/{id}/metadata-attachments/{attachmentId}
Télécharger une pièce jointe
downloadMetadataAttachment 2 params → 200401403404
DELETE
/datasets/{id}/metadata-attachments/{attachmentId}
Supprimer une pièce jointe
deleteMetadataAttachment 2 params → 204401403404
GET
/datasets/{id}/journal
Lister les événements
readJournal 1 param → 200401403404
POST
/datasets/{id}/user-notification
Envoyer une notification
sendUserNotification 1 param body → 200400401403404
GET
/datasets/{id}/permissions
Liste des permissions
getPermissions 1 param → 200
PUT
/datasets/{id}/permissions
Définir les permissions
setPermissions 1 param body → 200
GET
/datasets/{id}/read-api-key
Obtenir la clé d'API
getReadApiKey 1 param → 200401403404
JDD / Données 19
POST
/datasets/{id}
Mettre à jour les données
writeData 1 param body → 200400401403404409413
GET
/datasets/{id}/lines
Lire les lignes
readLines 21 params → 200400401403404
GET
/datasets/{id}/values/{field}
Lister les valeurs distinctes
getValues 12 params → 200400401403404
GET
/datasets/{id}/values-labels/{field}
Lister les valeurs avec libellés
getValuesLabels 11 params → 200400401403404
GET
/datasets/{id}/values_agg
Agréger les valeurs
getValuesAgg 23 params → 200400401403404
GET
/datasets/{id}/metric_agg
Calculer une métrique
getMetricAgg 12 params → 200400401403404
GET
/datasets/{id}/simple_metrics_agg
Calculer des métriques simples
getSimpleMetricsAgg 11 params → 200400401403404
GET
/datasets/{id}/words_agg
Lister les mots significatifs
getWordsAgg 11 params → 200400401403404
GET
/datasets/{id}/raw
Télécharger
downloadOriginalData 1 param → 200401403404
GET
/datasets/{id}/convert
Télécharger (format converti)
downloadConvertedData 1 param → 200401403404
GET
/datasets/{id}/full
Télécharger (données enrichies)
downloadFullData 1 param → 200401403404
GET
/datasets/{id}/data-files
Lister les fichiers
listDataFiles 1 param → 200401403404
GET
/datasets/{id}/data-files/{filePath}
Télécharger un fichier
downloadDataFile 2 params → 200401403404
GET
/datasets/{id}/attachments/{attachmentId}
Télécharger une pièce jointe
downloadAttachment 2 params → 200401403404
GET
/datasets/{id}/master-data/single-searchs/{singleSearchId}
Recherche unitaire
masterData_singleSearch_{singleSearchId} 3 params → 200
POST
/datasets/{id}/master-data/bulk-searchs/{bulkSearchId}
Recherche en masse
masterData_bulkSearch_{bulkSearchId} 2 params body → 200400
GET
/datasets/{id}/geo_agg
Agréger spatialement
getGeoAgg 19 params → 200400401403404
POST
/datasets/{id}/draft
Valider le brouillon
validateDraft 1 param → 200400401403404409
DELETE
/datasets/{id}/draft
Annuler le brouillon
cancelDraft 1 param → 200400401403404409
Applications 6
GET
/applications
Lister les applications
listApplications 11 params → 200400401403404
POST
/applications
Configurer une application
postApplication body → 201400401403
GET
/applications/{id}
Lire les informations d'une application
getApplication 1 param → 200401403404
PUT
/applications/{id}
Créer ou mettre à jour une application
putApplication 1 param body → 200201400401403404
PATCH
/applications/{id}
Modifier une application
patchApplication 1 param body → 200400401403404
DELETE
/applications/{id}
Supprimer une application
deleteApplication 1 param → 204401403404
JDD / Éditable 18
POST
/datasets/{id}/lines
Ajouter une ligne
createLine 1 param body → 201400401403404413
DELETE
/datasets/{id}/lines
Supprimer toutes les lignes
deleteAllLines 1 param → 204401403404
GET
/datasets/{id}/revisions
Récupérer les révisions
readRevisions 3 params → 200401403404
GET
/datasets/{id}/lines/{lineId}/revisions
Récupérer les révisions d'une ligne
readLineRevisions 4 params → 200401403404
GET
/datasets/{id}/lines/{lineId}
Récupérer une ligne
readLine 2 params → 200401403404
PUT
/datasets/{id}/lines/{lineId}
Remplacer une ligne
updateLine 2 params body → 200400401403404413
PATCH
/datasets/{id}/lines/{lineId}
Modifier une ligne
patchLine 2 params body → 200400401403404413
DELETE
/datasets/{id}/lines/{lineId}
Supprimer une ligne
deleteLine 2 params → 204401403404
POST
/datasets/{id}/_bulk_lines
Effectuer des opérations en masse
bulkLines 1 param body → 200400401403404413
GET
/datasets/{id}/own/{owner}/lines
Lire les lignes (par propriétaire)
readOwnLines 22 params → 200400401403404
POST
/datasets/{id}/own/{owner}/lines
Ajouter une ligne (par propriétaire)
createOwnLine 2 params body → 201400401403404413
GET
/datasets/{id}/own/{owner}/lines/{lineId}
Récupérer une ligne (par propriétaire)
readOwnLine 3 params → 200401403404
PUT
/datasets/{id}/own/{owner}/lines/{lineId}
Remplacer une ligne (par propriétaire)
updateOwnLine 3 params body → 200400401403404413
PATCH
/datasets/{id}/own/{owner}/lines/{lineId}
Modifier une ligne (par propriétaire)
patchOwnLine 3 params body → 200400401403404413
DELETE
/datasets/{id}/own/{owner}/lines/{lineId}
Supprimer une ligne (par propriétaire)
deleteOwnLine 3 params → 204401403404
POST
/datasets/{id}/own/{owner}/_bulk_lines
Effectuer des opérations en masse (par propriétaire)
bulkOwnLines 2 params body → 200400401403404413
GET
/datasets/{id}/own/{owner}/revisions
Récupérer les révisions (par propriétaire)
readRevisions 4 params → 200401403404
GET
/datasets/{id}/own/{owner}/lines/{lineId}/revisions
Récupérer les révisions d'une ligne (par propriétaire)
readOwnLineRevisions 5 params → 200401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are dataset (67 properties), datasetPost (40 properties), datasetPatch (35 properties), application (32 properties). Each schema is shown below with its type and property counts.

dataset
object
67 properties 4 required
datasetPatch
object
35 properties
datasetPost
object
40 properties
application
object
32 properties 5 required
applicationPatch
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

la-poste-groupe-open-data-openapi.json Raw ↑
Where this information came from

This is an independent, third-party profile of La Poste Open Data v1, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.