Mendapatkan daftar kandidat

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Otorisasi

api-token + language + role

Parameter permintaan

branch_idinteger

Contoh: 1

vacancy_idinteger

Contoh: 1

page_numberinteger

Contoh: 1

Tanggapan

object

statusstringwajib

Nilai:successerror

Contoh: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object

valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object

valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Nilai:force_shownvalue_required

Contoh: value_required

listarray of object

idintegerwajib

Contoh: 1

date_creationstring (DataTimeFormatSQL) wajib

Contoh: 2024-05-02 08:31:16

date_next_contactstring (DataTimeFormatSQL)

Contoh: 2024-05-02 08:31:16

namestringwajib

Contoh: Name

phone_format_idintegerwajib

Contoh: 1

phone_numberstringwajib

Contoh: 9999999999

date_of_birthstring

Contoh: 2010-10-22

genderstring (Gender)

Nilai:womanman

Contoh: man

educationstring (Education)

Nilai:highersecondaryelementaryspecialwithout

Contoh: special

emailstring

Contoh: example@example.com

messagestring

Contoh: Example

commentstring

Contoh: Example

statusstring (StatusCandidates) wajib

Nilai:deniednot_processedapprovednot_satisfied_with_conditionshired

Contoh: not_satisfied_with_conditions

messenger_telegrambooleanwajib

Contoh: false

messenger_whatsappbooleanwajib

Contoh: true

messenger_viberbooleanwajib

Contoh: true

messenger_facebookbooleanwajib

Contoh: false

vacancy_idintegerwajib

Contoh: 1

vacancy_namestringwajib

Contoh: Pianist

chain_idinteger

Contoh: 1

city_namestring

Contoh: London

branch_idinteger

Contoh: 1

photostring

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

paginationobject (Pagination)

max_countintegerwajib

Jumlah item per halaman

Contoh: 30

page_numberintegerwajib

Nomor halaman saat ini; dibatasi agar offset tidak melebihi 1000

Contoh: 1

has_nextbooleanwajib

Apakah ada halaman berikutnya

Contoh: true

has_previousbooleanwajib

Apakah ada halaman sebelumnya

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