Získat seznam kandidátů

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 1

vacancy_idinteger

Příklad: 1

page_numberinteger

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

listarray of object

idintegerpovinné

Příklad: 1

date_creationstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

namestringpovinné

Příklad: Name

phone_format_idintegerpovinné

Příklad: 1

phone_numberstringpovinné

Příklad: 9999999999

date_of_birthstring

Příklad: 2010-10-22

genderstring (Gender)

Hodnoty:womanman

Příklad: man

educationstring (Education)

Hodnoty:highersecondaryelementaryspecialwithout

Příklad: special

emailstring

Příklad: example@example.com

messagestring

Příklad: Example

commentstring

Příklad: Example

statusstring (StatusCandidates) povinné

Hodnoty:deniednot_processedapprovednot_satisfied_with_conditionshired

Příklad: not_satisfied_with_conditions

messenger_telegrambooleanpovinné

Příklad: false

messenger_whatsappbooleanpovinné

Příklad: true

messenger_viberbooleanpovinné

Příklad: true

messenger_facebookbooleanpovinné

Příklad: false

vacancy_idintegerpovinné

Příklad: 1

vacancy_namestringpovinné

Příklad: Pianist

chain_idinteger

Příklad: 1

city_namestring

Příklad: London

branch_idinteger

Příklad: 1

photostring

Příklad: https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777

paginationobject (Pagination)

max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } } }