Adayların listesini al

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Yetkilendirme

api-token + language + role

Sorgu parametreleri

branch_idinteger

Örnek: 1

vacancy_idinteger

Örnek: 1

page_numberinteger

Örnek: 1

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

listarray of object

idintegerzorunlu

Örnek: 1

date_creationstring (DataTimeFormatSQL) zorunlu

Örnek: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

namestringzorunlu

Örnek: Name

phone_format_idintegerzorunlu

Örnek: 1

phone_numberstringzorunlu

Örnek: 9999999999

date_of_birthstring

Örnek: 2010-10-22

genderstring (Gender)

Değerler:womanman

Örnek: man

educationstring (Education)

Değerler:highersecondaryelementaryspecialwithout

Örnek: special

emailstring

Örnek: example@example.com

messagestring

Örnek: Example

commentstring

Örnek: Example

statusstring (StatusCandidates) zorunlu

Değerler:deniednot_processedapprovednot_satisfied_with_conditionshired

Örnek: not_satisfied_with_conditions

messenger_telegrambooleanzorunlu

Örnek: false

messenger_whatsappbooleanzorunlu

Örnek: true

messenger_viberbooleanzorunlu

Örnek: true

messenger_facebookbooleanzorunlu

Örnek: false

vacancy_idintegerzorunlu

Örnek: 1

vacancy_namestringzorunlu

Örnek: Pianist

chain_idinteger

Örnek: 1

city_namestring

Örnek: London

branch_idinteger

Örnek: 1

photostring

Örnek: https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777

paginationobject (Pagination)

max_countintegerzorunlu

Sayfadaki öğe sayısı

Örnek: 30

page_numberintegerzorunlu

Geçerli sayfa numarası; offset 1000'ü aşmayacak şekilde sınırlandırılmıştır

Örnek: 1

has_nextbooleanzorunlu

Sonraki sayfa var mı

Örnek: true

has_previousbooleanzorunlu

Önceki sayfa var mı

Örnek: 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' => 'tr', '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": "tr", "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": "tr", "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 } } }