Ստանալ թեկնածուների ցանկը

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