Получить справочники для формы кандидатов

GET/api/crm/v2/candidates.fieldsv2

operationId: candidates.fields

Возвращает справочники для формы кандидатов. Вакансии фильтруются по branch_id.

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 8778

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

vacancy_idarray of object

valueintegerобязательный

Пример: 1

namestringобязательный

Пример: Pianist

publishedboolean

Пример: true

city_namestring

Пример: London

chain_namestring

Пример: Green Basket | London

genderobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string

modestring (FilterMode)

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

Значения:force_shownvalue_required

Пример: value_required

educationobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

statusobject (FilterEnum)

Фильтр-перечисление — плоский список значений перечисления

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of string

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/candidates.fields', [ '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.fields", { 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.fields", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "vacancy_id": [ { "value": 1, "name": "Pianist", "published": true, "city_name": "London", "chain_name": "Green Basket | London" } ], "gender": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "education": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "status": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }