Отримати список кандидатів

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Авторизація

api-token + language + role

Параметри запиту

branch_idinteger

Приклад: 1

vacancy_idinteger

Приклад: 1

page_numberinteger

Приклад: 1

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

listarray of object

idintegerобов’язковий

Приклад: 1

date_creationstring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

namestringобов’язковий

Приклад: Name

phone_format_idintegerобов’язковий

Приклад: 1

phone_numberstringобов’язковий

Приклад: 9999999999

date_of_birthstring

Приклад: 2010-10-22

genderstring (Gender)

Значення:womanman

Приклад: man

educationstring (Education)

Значення:highersecondaryelementaryspecialwithout

Приклад: special

emailstring

Приклад: example@example.com

messagestring

Приклад: Example

commentstring

Приклад: Example

statusstring (StatusCandidates) обов’язковий

Значення:deniednot_processedapprovednot_satisfied_with_conditionshired

Приклад: not_satisfied_with_conditions

messenger_telegrambooleanобов’язковий

Приклад: false

messenger_whatsappbooleanобов’язковий

Приклад: true

messenger_viberbooleanобов’язковий

Приклад: true

messenger_facebookbooleanобов’язковий

Приклад: false

vacancy_idintegerобов’язковий

Приклад: 1

vacancy_namestringобов’язковий

Приклад: Pianist

chain_idinteger

Приклад: 1

city_namestring

Приклад: London

branch_idinteger

Приклад: 1

photostring

Приклад: https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777

paginationobject (Pagination)

max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false

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

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

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/candidates", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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 } } }