Kandidatenliste abrufen

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

vacancy_idinteger

Beispiel: 1

page_numberinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object

idintegererforderlich

Beispiel: 1

date_creationstring (DataTimeFormatSQL) erforderlich

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

date_next_contactstring (DataTimeFormatSQL)

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

namestringerforderlich

Beispiel: Name

phone_format_idintegererforderlich

Beispiel: 1

phone_numberstringerforderlich

Beispiel: 9999999999

date_of_birthstring

Beispiel: 2010-10-22

genderstring (Gender)

Werte:womanman

Beispiel: man

educationstring (Education)

Werte:highersecondaryelementaryspecialwithout

Beispiel: special

emailstring

Beispiel: example@example.com

messagestring

Beispiel: Example

commentstring

Beispiel: Example

statusstring (StatusCandidates) erforderlich

Werte:deniednot_processedapprovednot_satisfied_with_conditionshired

Beispiel: not_satisfied_with_conditions

messenger_telegrambooleanerforderlich

Beispiel: false

messenger_whatsappbooleanerforderlich

Beispiel: true

messenger_viberbooleanerforderlich

Beispiel: true

messenger_facebookbooleanerforderlich

Beispiel: false

vacancy_idintegererforderlich

Beispiel: 1

vacancy_namestringerforderlich

Beispiel: Pianist

chain_idinteger

Beispiel: 1

city_namestring

Beispiel: London

branch_idinteger

Beispiel: 1

photostring

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

paginationobject (Pagination)

max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/candidates', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'de', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/candidates", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/candidates", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "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 } } }