API Integration documentation

List websites

The directory of the organization's websites, in full or by department.

GET /api/websites

The websites of the token's organization, sorted by name.

Check Value
Authentication Authorization: Bearer …
Cache response cached for one hour server-side 
curl https://api.example.com/api/websites \
  -H 'Authorization: Bearer 42|pQ7d…' \
  -H 'Accept: application/json'

Response 200

{
    "data": [{
        "id": "019f0000-0000-7000-8000-00000000000a",
        "name": "Portails & Fermetures",
        "host": "portails-fermetures.fr",
        "url": "https://portails-fermetures.fr",
        "email": "[email protected]",
        "company": "Portails & Fermetures SARL",
        "address": "12 rue des Remparts",
        "zipcode": "68000",
        "city": "Colmar",
        "country": "France",
        "phone": "03 89 00 00 00",
        "logo": "https://…/logos/7/logo.png",
        "departments": [{ "code": "68", "name": "Haut-Rhin" }],
        "created_at": "2026-07-08T10:51:02+00:00",
        "updated_at": "2026-09-15T09:22:41+00:00"
    }]
}

Errors

Code Body Cause
401 {"message": "Unauthenticated."} Token missing, unknown or expired
403 {"message": "This token does not grant access to any organization."} The bearer is no longer a member of the token's organization

The list is scoped to the token's organization. There is no endpoint returning the directory of all the platform's clients.

GET /api/websites/by-department/{code}

The organization's websites that serve a department.

Check Value
Authentication Authorization: Bearer …

Path parameters

Name Type Purpose
code string Reference code: 68, 2A, 971, or an area outside France (BEL, SUI, LUX, GEX, MAD, 993) 
curl https://api.example.com/api/websites/by-department/68 \
  -H 'Authorization: Bearer 42|pQ7d…'

Response 200 — same shape as GET /api/websites, filtered.

Errors

Code Cause
403 The bearer is no longer a member of the token's organization
404 Unknown department code, or no website of the organization serves it

The 404 deliberately covers both cases: a directory does not tell a token bearer which codes exist and which ones are simply empty on their side.

A typical use

A national website asks the visitor for their postal code and directs them to the branch serving their area: one by-department call, the first website returned, and a redirect to its url.