Отримати довідники для форми кандидатів

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