Authentication, endpoints, parameters, curl examples and JSON responses. Base: all URLs are relative to the production origin.
Send your partner token in one of these HTTP headers on every request (except the public catalog):
Authorization: Bearer <token>
# ou
X-Api-Key: <token>The request examples (curl) and response examples (JSON) are provided identically in all languages — they are technical data.
/api/v1PublicSelf-documented API catalog (public, no token).
curl "https://www.superalternance.com/api/v1"{
"name": "superalternance API partenaires",
"version": "1",
"authentication": { "type": "bearer", "description": "…" },
"endpoints": [ … ]
}/api/v1/suggestToken required"Occupation or training" autocomplete for a search bar.
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Query text (≥ 2 characters). |
limit | int | No | Number of suggestions (1–20, default 8). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/suggest?q=boul&limit=5"{
"query": "boul",
"suggestions": [
{ "kind": "rome", "value": "Boulanger", "secondary": "Métier" },
{ "kind": "formation", "value": "CAP Boulanger", "secondary": "CFA des métiers" }
]
}/api/v1/placesToken requiredLocation autocomplete: regions, departments and municipalities.
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Query text (≥ 2 characters). |
limit | int | No | Number of suggestions (1–12, default 8). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/places?q=lyon"{
"query": "lyon",
"suggestions": [
{ "kind": "city", "value": "Lyon", "secondary": "69001 · Rhône", "lat": 45.758, "lng": 4.835 }
]
}/api/v1/searchToken requiredUnified search for offers + training programs, filterable by location, occupation, training and level.
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | No | Free text (training title, keywords). |
metier | string | No | Job title — resolved to ROME codes (like LBA). |
lieu | string | No | Region / department / municipality. |
lat | float | No | Latitude (radius search). |
lng | float | No | Longitude (radius search). |
radius | float | No | Radius in km (default 30). |
type | enum | No | jobs | formations | all (default all). |
niveau | csv | No | Diploma levels among 3,4,5,6,7 (3=CAP … 7=Bac+5). |
sort | enum | No | relevance | date | diploma (default relevance). |
limit | int | No | Page size (1–100, default 20). |
offset | int | No | Pagination offset (default 0). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/search?metier=boulanger&lieu=Lyon&type=jobs&limit=5"{
"filters": { "metier": "boulanger", "resolvedRomeCodes": ["D1102", "D1104"], "lieu": "Lyon", "type": "jobs" },
"pagination": { "limit": 5, "offset": 0 },
"totals": { "jobs": 42, "formations": 0 },
"results": [
{
"kind": "job", "id": "…", "title": "Boulanger en alternance",
"subtitle": "Maison Dupain · Lyon", "city": "Lyon",
"latitude": 45.75, "longitude": 4.84,
"labels": ["Apprentissage", "CAP"],
"url": "https://www.superalternance.com/fr/offres/…"
}
]
}/api/v1/jobs/latestToken requiredLatest published work-study offers, with optional location filter.
| Parameter | Type | Required | Description |
|---|---|---|---|
lieu | string | No | Region / department / municipality. |
lat | float | No | Latitude (radius search). |
lng | float | No | Longitude (radius search). |
radius | float | No | Radius in km (default 30). |
limit | int | No | Number of job offers (1–100, default 20). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/jobs/latest?lieu=Bordeaux&limit=10"{
"filters": { "lieu": "Bordeaux" },
"total": 10,
"jobs": [
{ "id": "…", "title": "Développeur web en alternance", "subtitle": "Acme · Bordeaux",
"city": "Bordeaux", "latitude": 44.84, "longitude": -0.58,
"labels": ["Apprentissage"], "url": "https://www.superalternance.com/fr/offres/…" }
]
}/api/v1/jobs/{id}Token requiredFull detail of an offer: contract, employer, location, application.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | path | Yes | Job offer identifier (`id` field returned by the search). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/jobs/abc123"{
"job": {
"id": "abc123", "title": "Boulanger en alternance",
"contractTypes": ["Apprentissage"], "duration": "24 mois",
"location": { "city": "Lyon", "zipCode": "69003", "region": "Auvergne-Rhône-Alpes" },
"company": { "name": "Maison Dupain", "siret": "…", "siren": "…" },
"apply": { "email": null, "url": "…" }
}
}/api/v1/formations/{id}Token requiredFull detail of a training program: diploma, RNCP, provider (CFA), schedule.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | path | Yes | Training identifier (`id` field returned by the search). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/formations/xyz789"{
"formation": {
"id": "xyz789", "title": "CAP Boulanger", "diploma": "CAP",
"rncpCode": "RNCP…", "targetDiplomaLevel": "3",
"location": { "city": "Lyon", "region": "Auvergne-Rhône-Alpes" },
"cfa": { "name": "CFA des métiers", "siret": "…" }
}
}/api/v1/companies/{siret}Token requiredEmployer profile by SIRET and list of its open work-study offers.
| Parameter | Type | Required | Description |
|---|---|---|---|
siret | path | Yes | 14-digit SIRET. |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/companies/12345678901234"{
"company": {
"siret": "12345678901234", "siren": "123456789", "name": "Maison Dupain",
"size": "10 à 19 salariés", "nafCodes": ["1071C"],
"location": { "city": "Lyon", "region": "Auvergne-Rhône-Alpes" },
"openJobsCount": 3, "openJobs": [ … ]
}
}/api/v1/statsToken requiredAggregated platform statistics (+ counts by occupation).
| Parameter | Type | Required | Description |
|---|---|---|---|
metier | string | No | If provided, adds the counters specific to this job. |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/stats?metier=boulanger"{
"jobs": 17658, "formations": 58596, "cfa": 6923,
"lastSyncAt": "2026-06-04T21:01:06.369Z",
"metier": { "name": "boulanger", "jobs": 42, "formations": 120, "diplomas": 8 }
}Errors follow a single shape: { "error": { "code": "…", "message": "…" } }.
| Status | Code | Meaning |
|---|---|---|
400 | bad_request | Missing or invalid parameter. |
401 | unauthorized | Missing access token. |
403 | forbidden | Invalid access token. |
404 | not_found | Resource not found. |
500 | internal | Server error or API not configured. |
The public JSON catalog describes all endpoints, parameters and errors in a machine-readable way, without authentication. An ideal entry point for an agent discovering the API.