API

Obtenir la liste des candidats

GET/api/crm/v2/candidatesv2
operationId: candidates.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

vacancy_idinteger

Exemple: 1

page_numberinteger

Exemple: 1

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

vacancy_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of object
idintegerobligatoire

Exemple: 1

date_creationstring (DataTimeFormatSQL) obligatoire

Exemple: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Exemple: 2024-05-02 08:31:16

namestringobligatoire

Exemple: Name

phone_format_idintegerobligatoire

Exemple: 1

phone_numberstringobligatoire

Exemple: 9999999999

date_of_birthstring

Exemple: 2010-10-22

genderstring (Gender)

Valeurs:womanman

Exemple: man

educationstring (Education)

Valeurs:highersecondaryelementaryspecialwithout

Exemple: special

emailstring

Exemple: example@example.com

messagestring

Exemple: Example

commentstring

Exemple: Example

statusstring (StatusCandidates) obligatoire

Valeurs:deniednot_processedapprovednot_satisfied_with_conditionshired

Exemple: not_satisfied_with_conditions

messenger_telegrambooleanobligatoire

Exemple: false

messenger_whatsappbooleanobligatoire

Exemple: true

messenger_viberbooleanobligatoire

Exemple: true

messenger_facebookbooleanobligatoire

Exemple: false

vacancy_idintegerobligatoire

Exemple: 1

vacancy_namestringobligatoire

Exemple: Pianist

chain_idinteger

Exemple: 1

city_namestring

Exemple: London

branch_idinteger

Exemple: 1

photostring

Exemple: https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777

paginationobject (Pagination)
max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false