Obtener la lista de candidatos

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

vacancy_idinteger

Ejemplo: 1

page_numberinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 1

date_creationstring (DataTimeFormatSQL) obligatorio

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

date_next_contactstring (DataTimeFormatSQL)

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

namestringobligatorio

Ejemplo: Name

phone_format_idintegerobligatorio

Ejemplo: 1

phone_numberstringobligatorio

Ejemplo: 9999999999

date_of_birthstring

Ejemplo: 2010-10-22

genderstring (Gender)

Valores:womanman

Ejemplo: man

educationstring (Education)

Valores:highersecondaryelementaryspecialwithout

Ejemplo: special

emailstring

Ejemplo: example@example.com

messagestring

Ejemplo: Example

commentstring

Ejemplo: Example

statusstring (StatusCandidates) obligatorio

Valores:deniednot_processedapprovednot_satisfied_with_conditionshired

Ejemplo: not_satisfied_with_conditions

messenger_telegrambooleanobligatorio

Ejemplo: false

messenger_whatsappbooleanobligatorio

Ejemplo: true

messenger_viberbooleanobligatorio

Ejemplo: true

messenger_facebookbooleanobligatorio

Ejemplo: false

vacancy_idintegerobligatorio

Ejemplo: 1

vacancy_namestringobligatorio

Ejemplo: Pianist

chain_idinteger

Ejemplo: 1

city_namestring

Ejemplo: London

branch_idinteger

Ejemplo: 1

photostring

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

paginationobject (Pagination)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

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