Ottenere l'elenco dei candidati

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 1

vacancy_idinteger

Esempio: 1

page_numberinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

listarray of object

idintegerobbligatorio

Esempio: 1

date_creationstring (DataTimeFormatSQL) obbligatorio

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

date_next_contactstring (DataTimeFormatSQL)

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

namestringobbligatorio

Esempio: Name

phone_format_idintegerobbligatorio

Esempio: 1

phone_numberstringobbligatorio

Esempio: 9999999999

date_of_birthstring

Esempio: 2010-10-22

genderstring (Gender)

Valori:womanman

Esempio: man

educationstring (Education)

Valori:highersecondaryelementaryspecialwithout

Esempio: special

emailstring

Esempio: example@example.com

messagestring

Esempio: Example

commentstring

Esempio: Example

statusstring (StatusCandidates) obbligatorio

Valori:deniednot_processedapprovednot_satisfied_with_conditionshired

Esempio: not_satisfied_with_conditions

messenger_telegrambooleanobbligatorio

Esempio: false

messenger_whatsappbooleanobbligatorio

Esempio: true

messenger_viberbooleanobbligatorio

Esempio: true

messenger_facebookbooleanobbligatorio

Esempio: false

vacancy_idintegerobbligatorio

Esempio: 1

vacancy_namestringobbligatorio

Esempio: Pianist

chain_idinteger

Esempio: 1

city_namestring

Esempio: London

branch_idinteger

Esempio: 1

photostring

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

paginationobject (Pagination)

max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/candidates', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'it', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/candidates", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "it", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/candidates", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "it", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "vacancy_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "list": [ { "id": 1, "date_creation": "2024-05-02 08:31:16", "date_next_contact": "2024-05-02 08:31:16", "name": "Name", "phone_format_id": 1, "phone_number": "9999999999", "date_of_birth": "2010-10-22", "gender": "man", "education": "special", "email": "example@example.com", "message": "Example", "comment": "Example", "status": "not_satisfied_with_conditions", "messenger_telegram": false, "messenger_whatsapp": true, "messenger_viber": true, "messenger_facebook": false, "vacancy_id": 1, "vacancy_name": "Pianist", "chain_id": 1, "city_name": "London", "branch_id": 1, "photo": "https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }