Iegūt kandidātu sarakstu

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 1

vacancy_idinteger

Piemērs: 1

page_numberinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

listarray of object

idintegerobligāts

Piemērs: 1

date_creationstring (DataTimeFormatSQL) obligāts

Piemērs: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

namestringobligāts

Piemērs: Name

phone_format_idintegerobligāts

Piemērs: 1

phone_numberstringobligāts

Piemērs: 9999999999

date_of_birthstring

Piemērs: 2010-10-22

genderstring (Gender)

Vērtības:womanman

Piemērs: man

educationstring (Education)

Vērtības:highersecondaryelementaryspecialwithout

Piemērs: special

emailstring

Piemērs: example@example.com

messagestring

Piemērs: Example

commentstring

Piemērs: Example

statusstring (StatusCandidates) obligāts

Vērtības:deniednot_processedapprovednot_satisfied_with_conditionshired

Piemērs: not_satisfied_with_conditions

messenger_telegrambooleanobligāts

Piemērs: false

messenger_whatsappbooleanobligāts

Piemērs: true

messenger_viberbooleanobligāts

Piemērs: true

messenger_facebookbooleanobligāts

Piemērs: false

vacancy_idintegerobligāts

Piemērs: 1

vacancy_namestringobligāts

Piemērs: Pianist

chain_idinteger

Piemērs: 1

city_namestring

Piemērs: London

branch_idinteger

Piemērs: 1

photostring

Piemērs: https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777

paginationobject (Pagination)

max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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 } } }