Получить список кандидатов

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.pro/api/crm/v2/candidates', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', '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": "ru", "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": "ru", "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 } } }