Obter a lista de candidatos

GET/api/crm/v2/candidatesv2

operationId: candidates.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

vacancy_idinteger

Exemplo: 1

page_numberinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

vacancy_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 1

date_creationstring (DataTimeFormatSQL) obrigatório

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

date_next_contactstring (DataTimeFormatSQL)

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

namestringobrigatório

Exemplo: Name

phone_format_idintegerobrigatório

Exemplo: 1

phone_numberstringobrigatório

Exemplo: 9999999999

date_of_birthstring

Exemplo: 2010-10-22

genderstring (Gender)

Valores:womanman

Exemplo: man

educationstring (Education)

Valores:highersecondaryelementaryspecialwithout

Exemplo: special

emailstring

Exemplo: example@example.com

messagestring

Exemplo: Example

commentstring

Exemplo: Example

statusstring (StatusCandidates) obrigatório

Valores:deniednot_processedapprovednot_satisfied_with_conditionshired

Exemplo: not_satisfied_with_conditions

messenger_telegrambooleanobrigatório

Exemplo: false

messenger_whatsappbooleanobrigatório

Exemplo: true

messenger_viberbooleanobrigatório

Exemplo: true

messenger_facebookbooleanobrigatório

Exemplo: false

vacancy_idintegerobrigatório

Exemplo: 1

vacancy_namestringobrigatório

Exemplo: Pianist

chain_idinteger

Exemplo: 1

city_namestring

Exemplo: London

branch_idinteger

Exemplo: 1

photostring

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

paginationobject (Pagination)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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 } } }