Aller au contenu principal

Récupération des candidatures

Description​

Récupère une liste paginée de candidatures, filtrée par date, source ou localisation, et triée par date.


Endpoint​

GET https://api.mytalentplug.com/jam/v1/jobapplications

Authentification​

  • Requise : Oui
  • Type : Bearer Authentication
  • Exemple d’en-tête :
Authorization: Bearer <token>

Requête​

Paramètres de query​

Nom du paramètreTypeRequisPar défautFormatExempleDescription
pageintegerNon1≥ 11Numéro de la page
pageSizeintegerNon251–5010Nombre d’éléments par page
fromDatestringNon—ISO 86012025-01-01T00:00:00ZDate de début du filtre (inclusif). Les candidatures dont la date est antérieure à cette valeur ne seront pas incluses dans les résultats
toDatestringNon—ISO 86012025-01-31T23:59:59ZDate de fin du filtre (inclusif). Les candidatures dont la date est postérieure à cette valeur ne seront pas incluses dans les résultats
sourceNamestringNon——Site carrièreLe nom exact ou partiel de la source de la candidature
jobLocationstringNon——Paris - 75000Le nom exact ou partiel de ville de localisation du poste
sortByDatesbyteNon-11 ou -11Tri par date : 1 = de la plus ancienne à la plus récente, -1 = de la plus récente à la plus ancienne

Réponse​

La réponse est au format JSON.

Réponse 200 (succès)​

Exemple​
{
"items": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
"ownerId": 42,
"companyId": 99,
"date": "2025-04-13T10:30:00Z",
"applicant": {
"firstName": "Alice",
"lastName": "Durand",
"fullname": "Alice Durand",
"email": "alice@example.com",
"phoneNumber": "0123456789"
},
"jobOffer": {
"id": "123456",
"reference": "REF-ABC-123",
"atsExternalId" : null,
"jobTitle": "Développeur .NET",
"jobLocation": "Paris - 75000"
},
"source": "Site carrière",
"sourceId": 3,
"rating": 5,
"attachments": [
{
"id": "g8d37995-b3c0-4223-9d73-a35ec7d4f447",
"fileName": "CV.pdf",
"fileExtension": "pdf",
"contentType": "application/pdf",
"type": 2,
"date": "2025-04-13T16:09:55.665Z"
}
],
"tags": ["urgent", "prioritaire"],
"recruitmentStepId": "ddee6677-8899-aabb-ccdd-1234567890ab",
"status": 1,
"duplicatesCount": 3,
"isMultiApplicationDuplicate": false
}
],
"page": 1,
"pageSize": 1,
"totalCount": 80,
"hasNextPage": true,
"hasPreviousPage": false
}
Détail des champs

Propriétés de la réponse​

ChampTypeDescription
itemsarrayListe des candidatures correspondant aux critères de recherche. Chaque élément contient les informations détaillées sur une candidature. Voir items.
pageintegerNuméro de la page actuelle.
pageSizeintegerNombre d’éléments renvoyés dans la page.
totalCountintegerNombre total de candidatures correspondant aux critères.
hasNextPagebooleanIndique s’il existe une page suivante.
hasPreviousPagebooleanIndique s’il existe une page précédente.

Schéma items​

ChampTypeDescription
idstring (UUID)Identifiant unique de la candidature.
ownerIdintegerIdentifiant de l'utilisateur qui a créé ou qui gère la candidature.
companyIdintegerIdentifiant de l’entreprise associée à la candidature.
datestring (ISO 8601)Date de réception de la candidature.
applicantobjectInformations sur le candidat. Voir applicant.
jobOfferobjectInformations sur l’offre d’emploi concernée. Voir joboffer.
sourcestringNom de la source de la candidature.
sourceIdintegerIdentifiant de la source.
ratingintegerNote ou évaluation de la candidature (0 à 5).
attachmentsarrayListe des fichiers joints à la candidature. Voir attachments.
tagsarray de stringsListe de mots-clés associés à la candidature.
recruitmentStepIdstring (UUID)Identifiant de l’étape de recrutement actuelle.
statusintegerStatut de la candidature (0 : non lue, 1 : réouverte, 2 : ouverte, 3 : retenue, 4 : non retenue, 5 : redirigée).
duplicatesCountintegerNombre de doublons détectés pour cette candidature.
isMultiApplicationDuplicatebooleanIndique si le candidat a postulé plusieurs fois au même poste.

Schéma applicant​

ChampTypeDescription
firstNamestringPrénom du candidat.
lastNamestringNom de famille du candidat.
fullnamestringNom complet du candidat.
emailstringAdresse e-mail du candidat.
phoneNumberstringNuméro de téléphone du candidat.

Schéma jobOffer​

ChampTypeDescription
idstringIdentifiant de l’offre d’emploi.
referencestringRéférence de l’offre d’emploi.
atsExternalIdstringIdentifiant de l’offre d’emploi fourni par l'ATS.
jobTitlestringIntitulé du poste proposé.
jobLocationstringLocalisation du poste (ex. : ville - code postal).

Schéma attachments​

ChampTypeDescription
idstring (UUID)Identifiant unique du fichier.
fileNamestringNom du fichier.
fileExtensionstringExtension du fichier (ex. : pdf).
contentTypestringType MIME du fichier (ex. : application/pdf).
typeintegerType du document (Valeur possible dans "Type de pièce jointe" ci-dessous).
datestring (ISO 8601)Date de dépôt du fichier.

Type de pièce jointe​

CodeLibelleDescription
0UntypedType de document non identifié
1MessageMessage associé à la candidature
2ResumeCurriculum vitae
3CoverLetterLettre de motivation
4ArchiveArchive (format compressé)
5OtherAutre type de document

Réponses d’erreur​

Code HTTPMessageDescription
400Bad RequestParamètre invalide (ex : sortByDate différent de 1 ou -1)
401UnauthorizedJeton d’accès manquant ou invalide
403ForbiddenAccès refusé
429Too Many RequestsLimite d'appels dépassée (voir Limites d'appels)
500Internal Server ErrorLe serveur a rencontré un problème inattendu
Exemple​
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation failed: \n -- PageSize: must be between 1 and 50 Severity: Error",
"traceId": "0HNB7RMJ268SM:00000003",
"requestId": "00-19aae3969015288f7162ad681f003a16-af9a7edd53036350-00"
}

Exemple de requête avec curl​

curl -X GET 'https://api.mytalentplug.com/jam/v1/jobapplications?page=1&pageSize=10&fromDate=2024-01-01T00:00:00Z&toDate=2024-12-31T23:59:59Z&jobLocation=Paris&sortByDate=1' \
-H 'Authorization: Bearer <token>'