Pobierz listę kandydatów

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 1

vacancy_idinteger

Przykład: 1

page_numberinteger

Przykład: 1

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

listarray of object

idintegerwymagane

Przykład: 1

date_creationstring (DataTimeFormatSQL) wymagane

Przykład: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

namestringwymagane

Przykład: Name

phone_format_idintegerwymagane

Przykład: 1

phone_numberstringwymagane

Przykład: 9999999999

date_of_birthstring

Przykład: 2010-10-22

genderstring (Gender)

Wartości:womanman

Przykład: man

educationstring (Education)

Wartości:highersecondaryelementaryspecialwithout

Przykład: special

emailstring

Przykład: example@example.com

messagestring

Przykład: Example

commentstring

Przykład: Example

statusstring (StatusCandidates) wymagane

Wartości:deniednot_processedapprovednot_satisfied_with_conditionshired

Przykład: not_satisfied_with_conditions

messenger_telegrambooleanwymagane

Przykład: false

messenger_whatsappbooleanwymagane

Przykład: true

messenger_viberbooleanwymagane

Przykład: true

messenger_facebookbooleanwymagane

Przykład: false

vacancy_idintegerwymagane

Przykład: 1

vacancy_namestringwymagane

Przykład: Pianist

chain_idinteger

Przykład: 1

city_namestring

Przykład: London

branch_idinteger

Przykład: 1

photostring

Przykład: https://cdn.foodsoul.test/zones/ru/branches/8778/images/candidates/578a215d632b422b26c8bcb77a956d8e.jpg?v1727165777

paginationobject (Pagination)

max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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 } } }