კანდიდატების სიის მიღება

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