Skip to content

Back to the plan Grands comptes

Grands comptes

The Jobs and Training APIs

The listings of all your branches, published from your software and kept up to date on their own

You add, change or remove a job offer or a course in your software: heyalink does the same on the branch’s business page. Nothing is typed twice.

Two ways to publish your job offers and courses

You choose, branch by branch. You can also combine both on the same business page.

By hand

From each business page: “Publish a job offer” in the Jobs section, “Publish a course” in the Training section. Handy for a few listings.

With every plan

Automatically, through the APIs

Your recruitment or training software sends your listings to heyalink, each one to its branch’s business page. Added, changed or removed on your side, a listing is too on heyalink.

Both APIs are included in Grands comptes

What the APIs change for a group

Several branches, several business pages, one software: each listing goes to the right place.

  • One key per business page

    Each branch has its business page and its keys. A listing sent with a branch’s key only appears on its page.

  • Everything updates on its own

    A listing added, changed, filled or removed in your software is too on heyalink, for all your branches at once.

  • One screen for the group

    The API tab of your space shows each business page: its keys, its webhooks, its source, and what is left to do (a site to prove, a key to create, a failing webhook).

  • A budget that holds

    When the invoice reaches the cap you chose, new listings wait offline, whether they come through the APIs or by hand.

Three ways to connect your listings

  1. No development: an addressFor your job offers: the address of your careers page, of your Greenhouse, Lever, Recruitee, SmartRecruiters or Ashby page, or of an XML, RSS or JSON feed (500 offers and 5 MB at most). For your courses: that of your LHEO or JSON catalogue. heyalink reads it again on its own: every 10 minutes at the soonest, every 6 hours at the latest.
  2. Your full list in one callYour software sends the list of all your references: listings published through the API that are no longer in it are archived. For your courses, it can also send your LHEO catalogue as it is, 5 MB at most.
  3. The API, listing by listingYour software sends each job offer or course as JSON. An AI assistant can do it too, through the MCP server.

What the two APIs do

Each listing carries your reference, its code on your side. Sending the same reference twice updates the listing: it is never published twice.

The Jobs API, for your job offers

Included in Grands comptes

What you doThe call
Publish a job offer, or update it PUT /offres/{reference}
Read a job offer and its status GET /offres/{reference}
List your job offers, page by page GET /offres
Say a job offer is filled: it leaves heyalink POST /offres/{reference}/pourvue
Archive a job offer: it leaves heyalink and comes back if you send it again POST /offres/{reference}/archivage
Remove a job offer DELETE /offres/{reference}
Send up to 100 job offers and 100 removals in a single call POST /offres/lot
Send the full list of your references: job offers published through the API that are not in it are archived POST /offres/synchronisation

The Training API, for your courses

Included in Grands comptes Pro Formation

What you doThe call
Publish a course, or update it PUT /formations/{reference}
Read a course and its status GET /formations/{reference}
List your courses, page by page GET /formations
Say a session is full: the course leaves heyalink POST /formations/{reference}/pourvue
Archive a course: it leaves heyalink and comes back if you send it again POST /formations/{reference}/archivage
Remove a course DELETE /formations/{reference}
Send up to 100 courses and 100 removals in one call POST /formations/lot
Send the full list of your references: API courses missing from it are archived POST /formations/synchronisation
Send your LHEO catalogue as it is, 5 MB at most POST /formations/lheo

And around the listings

The same tools for both APIs, on each business page.

  • Webhooksheyalink notifies your software with a signed call when a listing is online, pending, hidden by moderation, expired, archived, filled, closed, reopened, deleted or refused on a photo or a PDF. 5 addresses at most per business page and per API.
  • The logThe latest calls and their result, kept 90 days. Also readable on the API screen of each business page.
  • The test keyThe same answers as a real key, without publishing anything. Test listings are deleted after 7 days.
  • Dry-run validationWith a real key, the call is fully checked, but nothing is published.
  • OAuth 2.0For software that prefers it: the key is exchanged for a 60-minute token.
  • Proof of your sitesYou prove your sites are yours, with a tag or a file. Nobody publishes in your name, and an application link only leads to you.
  • Invited developers5 at most for the whole group. They open the API screen of each business page and manage their own keys and webhooks there, without seeing amounts, invoices or the content of the pages.
  • The MCP serverYour AI assistants list, publish, archive and remove your job offers and courses, with the same key.
  • Checking the keyOne call tells which business page the key belongs to and what it can do. Another, public and keyless, gives the API status.

The details of a listing

Three are required, for a job offer as for a course. The others file your listings better in searches and filters.

A job offer

Required

Job title
titre
Text of the offer
description
City (otherwise, that of the business page)
lieu

The position

Postcode
code_postal
Permanent, fixed-term, temp, internship…
type_contrat
Contract length (fixed-term, temporary)
duree_nombre
In days, weeks or months
duree_unite
Full or part time
temps_de_travail
Remote work: no, partial or full
teletravail
Apprenticeship or professionalisation
alternance
Experience required, in months
experience_mois
End date of the offer (ignored since 07/11/2026)
date_expiration
Link to apply on your side
lien_candidature

The description in blocks

“The job” block
description_poste
“Responsibilities” block
description_missions
“Profile” block
description_profil
“Benefits” block
description_avantages

The salary

Salary, as you display it
salaire
Bottom of the range, gross
salaire_min
Top of the range
salaire_max
Per hour, day, week, month or year
salaire_periode

The occupation and the sector

Occupation, as text
metier
Occupation code
metier_code
Occupation family
famille_code
ROME code
code_rome
Business sector
secteur

A course

Required

Title
titre
Description
presentation
Link to your course page or sign-up
lien

The session

Training provider
organisme
On site, remote or blended
mode
City
lieu
Postcode
code_postal
Length in hours
duree_heures
Date of the next session
debut
Price incl. VAT per trainee
prix
pro_formation.api.champs.libelles.photo_url
photo_url
pro_formation.api.champs.libelles.photo_base64
photo_base64

Who it is for

Target audience
pour_qui
Required level (free text)
niveau_d_entree
Required level (code)
niveau_entree
Prerequisites
prerequis
Objectives
objectifs
Practical information
infos_pratiques

The target occupation

Trade, as text
metier
Trade code
metier_code
Trade family
famille_code
ROME code
code_rome

Funding and certification

Funding: CPF, OPCO, France Travail, Region, employer
financements
Diploma, licence or certificate
type_certification
RNCP code
code_rncp
RS code
code_rs
pro_formation.api.champs.libelles.certification
certification
pro_formation.api.champs.libelles.diplome
diplome
pro_formation.api.champs.libelles.niveau_certification
niveau_certification
pro_formation.api.champs.libelles.attestation
attestation
Apprenticeship or professionalisation
alternance

When a detail is missing, heyalink infers it when it can (the occupation, from the ROME code or the title, for example) and tells you. It is never presented as yours.

The business page logo and a listing’s image are added on heyalink: they do not go through the API.

How to get access

The Jobs API is reserved for Grands comptes

The Training API is included in Grands comptes Pro Formation

  1. Subscribe to Grands comptes and bring your business pages togetherOne business page per branch or site, attached to your space. Access opens as soon as the plan is running.
  2. Open the API tab of your spaceThe holder and the administrators see all the group’s business pages there. “Open” leads to the API screen of each.
  3. Create one key per business page, or invite your developersThe holder and the administrators of the business page create its keys: up to 10 active per API, one per software. Your developers, 5 at most for the group, create their own.
  4. Prove your sites, then publishA tag or a file on your site is enough. Then your listings go online.

The limits

Calls
300 per minute and per key, 60 with a test key
Keys
10 active per business page and per API
Batch
100 listings and 100 removals per call
Webhooks
5 addresses per business page and per API
Developers
5 for the whole group, invitations included
Invoice
The monthly cap you choose. Once reached, your new listings wait offline. Raising it puts back online those that fit under the new cap.

If the plan stops, your keys no longer answer, but they are not deleted. Everything resumes when the plan resumes.

For your provider

Everything needed to connect your software. The documentation is readable without an account, even before subscribing.

Jobs API address
https://heyalink.com/api/emploi/v1
Training API address
https://heyalink.com/api/formation/v1
Format
JSON in UTF-8; LHEO in XML for a course catalogue
Description
OpenAPI 3.1, to import into Postman, Insomnia or a client generator
Key
In the Authorization header, one key per business page and per API. A Jobs API key does nothing on courses
Retry safely
Idempotency-Key header, valid 24 hours
Errors
In RFC 9457 format, in French or English
Replacing a key
The old one still works 7 days, or stops at once after a leak

Your questions

Do we need a developer?

Not necessarily. If your careers page, your recruitment software or your course catalogue already has an address, paste it on the API screen of the business page. Then add to your site the tag or the file that proves it is yours. For the API, whoever runs your software handles it with the documentation.

Can we publish by hand and through the APIs?

Yes, on the same business page. A synchronisation only touches listings that came the same way: those typed by hand stay as they are.

Are API listings billed?

Yes, like the others: each job offer and each course online counts to the day, according to the Grands comptes grid. Pending listings do not count.

Can we try before publishing?

Yes. The test key gives the same answers as a real key and publishes nothing.

Do our developers see our invoices?

No. An invited developer only opens the API screens of your business pages: no amounts, no invoices, no team.

Grands comptes

All your branches connected to heyalink

Subscription : €499 excl. VAT per month. Then your online listings, to the day.

Your cookie choices

With your consent, Heyalink measures site traffic with Google Analytics, and counts views of sponsored ads to bill their advertisers. Nothing is set before you choose, and declining changes nothing about how you use the site. Your choice is kept for six months; you can change it at any time with "Manage cookies" at the bottom of the page. Find out more

Customise

Nothing is set before you choose, and declining changes nothing about how you use the site. Your choice is kept for six months; you can change it at any time with "Manage cookies" at the bottom of the page. Find out more

Choose category by category