Schema Explorer

10 schemas components.schemas. Spec : JSON / YAML. Opérations : /developpeurs/api-explorer. Catalogue : /developpeurs/api-catalog.

Licence CC-BY 4.0 — citez Source : ServicesArtisans.

AskRequest

object1 required

Name	Type	Description	Enum
query*	string
classification	string
aidesContext	object
citedSources	array

Example

{
  "query": "string"
}

Used by

POST/api/v1/ask

AskResponse

object

Name	Type	Description	Enum
result	object
_meta	object

Example

{
  "result": {
    "ok": true
  },
  "_meta": {
    "api_version": "v1",
    "license": "CC-BY-4.0"
  }
}

Used by

POST/api/v1/ask

CeeBaremeResponse

object

Name	Type	Description	Enum
result	object
input	object
_meta	object

Example

{
  "result": {
    "eligible": true,
    "montant_eur": 0,
    "reason": "string"
  },
  "input": {},
  "_meta": {}
}

Used by

GET/api/v1/aides/cee-bareme

DepartmentStatsDataset

object5 required

Name	Type	Description	Enum
@context*	string
@type*	string
@id	string · uri
name*	string
description	string
url	string · uri
license	string · uri
creator	object
isBasedOn	string · uri
keywords	array
temporalCoverage	string
distribution	array
metadata*	object
stats*	object

Example

{
  "@context": "https://schema.org",
  "@type": "Dataset",
  "name": "string",
  "metadata": {
    "attribution": "string",
    "generatedAt": "2026-05-21T16:00:00.000Z",
    "departmentCode": "string"
  },
  "stats": {
    "totalProviders": 0,
    "totalRgeActive": 0,
    "rgePenetration": 0
  }
}

Used by

GET/api/v1/stats/department/{code}

ErrorResponse

object1 required

Name	Type	Description	Enum
error*	object
_meta	object

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Used by

POST/api/v1/ask
GET/api/v1/aides/mpr-bareme

Geste

string

Example

"pac_air_eau"

Used by

GET/api/v1/aides/mpr-bareme
GET/api/v1/aides/cee-bareme

MenageCategorie

string

Example

"tres_modeste"

Used by

GET/api/v1/aides/mpr-bareme
GET/api/v1/aides/cee-bareme

MprBaremeResponse

object

Name	Type	Description	Enum
result	object
input	object
_meta	object

Example

{
  "result": {
    "eligible": true,
    "montant_eur": 0,
    "plafond_eur": 0,
    "reason": "string"
  },
  "input": {},
  "_meta": {}
}

Used by

GET/api/v1/aides/mpr-bareme

RgeGeoJsonFeatureCollection

object3 required

Name	Type	Description	Enum
type*	string
metadata*	object
features*	array

Example

{
  "type": "FeatureCollection",
  "metadata": {
    "attribution": "string",
    "license": "https://example.com/",
    "source": "https://example.com/",
    "generatedAt": "2026-05-21T16:00:00.000Z",
    "totalCount": 0,
    "returnedCount": 0,
    "limit": 0,
    "offset": 0,
    "deptFilter": null
  },
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          0
        ]
      },
      "properties": {
        "slug": null,
        "name": "string",
        "city": null,
        "department": null,
        "qualifications": [
          {
            "code": "string",
            "nom": "string",
            "organisme": "string",
            "date_fin": "2026-05-21"
          }
        ]
      }
    }
  ]
}

Used by

GET/api/v1/rge/geojson

WebhookSubscribeRequest

object2 required

Name	Type	Description	Enum
url*	string · uri
email	string · email
events*	array

Example

{
  "url": "https://example.com/",
  "events": [
    "rge.snapshot.refreshed"
  ]
}

Used by

POST/api/v1/webhooks/subscribe