Obține lista candidaților

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorizare

api-token + language + role

Parametri de interogare

branch_idinteger

Exemplu: 1

vacancy_idinteger

Exemplu: 1

page_numberinteger

Exemplu: 1

Răspunsuri

object

statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Exemplu: value_required

listarray of object

idintegerobligatoriu

Exemplu: 1

date_creationstring (DataTimeFormatSQL) obligatoriu

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

date_next_contactstring (DataTimeFormatSQL)

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

namestringobligatoriu

Exemplu: Name

phone_format_idintegerobligatoriu

Exemplu: 1

phone_numberstringobligatoriu

Exemplu: 9999999999

date_of_birthstring

Exemplu: 2010-10-22

genderstring (Gender)

Valori:womanman

Exemplu: man

educationstring (Education)

Valori:highersecondaryelementaryspecialwithout

Exemplu: special

emailstring

Exemplu: example@example.com

messagestring

Exemplu: Example

commentstring

Exemplu: Example

statusstring (StatusCandidates) obligatoriu

Valori:deniednot_processedapprovednot_satisfied_with_conditionshired

Exemplu: not_satisfied_with_conditions

messenger_telegrambooleanobligatoriu

Exemplu: false

messenger_whatsappbooleanobligatoriu

Exemplu: true

messenger_viberbooleanobligatoriu

Exemplu: true

messenger_facebookbooleanobligatoriu

Exemplu: false

vacancy_idintegerobligatoriu

Exemplu: 1

vacancy_namestringobligatoriu

Exemplu: Pianist

chain_idinteger

Exemplu: 1

city_namestring

Exemplu: London

branch_idinteger

Exemplu: 1

photostring

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

paginationobject (Pagination)

max_countintegerobligatoriu

Numărul de elemente pe pagină

Exemplu: 30

page_numberintegerobligatoriu

Numărul paginii curente; limitat astfel încât offset-ul să nu depășească 1000

Exemplu: 1

has_nextbooleanobligatoriu

Există o pagină următoare

Exemplu: true

has_previousbooleanobligatoriu

Există o pagină anterioară

Exemplu: 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' => 'ro', '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": "ro", "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": "ro", "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 } } }