Listando fluxos (pipes)
Atenção: é obrigatório que a requisição realizada seja do tipo "Content-type: application/json".
Headers necessários:
| Nome | Valor | Descrição |
|---|---|---|
| Authorization | Bearer ...................... | Bearer Token para autenticação. Saiba mais aqui. |
| Content-Type | application/json | Define o tipo de formato de conteúdo que será enviado. |
Uma vez que os Headers estejam devidamente configurados, podemos ir ao próximo passo.
Endpoint utilizado para listar os fluxos (pipes):
| Endpoint | Método | Link para Teste |
|---|---|---|
| /api/v1/pipes | GET | Clique aqui |
Após realizar a requisição, você receberá um array contendo a lista de fluxos cadastrados na empresa.
Exemplo:
[
{
"id": 101,
"company_id": 999,
"manager_id": 201,
"name": "Pipeline Vendas Internas",
"created_at": "2023-04-10 09:00:00",
"updated_at": "2023-04-10 09:00:00",
"deleted_at": null,
"is_ultra": 0,
"original_pipe_id": null,
"pipe_stages_count": 3,
"vacancies_count": 5,
"manager": { /* ... dados do manager ... */ }
},
{
"id": 102,
"company_id": 999,
"manager_id": 202,
"name": "Fluxo Desenvolvedores Backend",
"created_at": "2023-06-15 11:20:00",
"updated_at": "2023-06-15 11:20:00",
"deleted_at": null,
"is_ultra": 1,
"original_pipe_id": null,
"pipe_stages_count": 4,
"vacancies_count": 2,
"manager": { /* ... dados do manager ... */ }
}
]Definição dos campos recebidos:
| Campo | Tipo | Definição |
|---|---|---|
| id | int | ID do pipe |
| company_id | int | ID da empresa que criou o pipe |
| manager_id | int | ID do manager que criou o pipe |
| name | string | Nome do Fluxo em questão |
| created_at | datetime | Data e hora de quando o fluxo foi criado |
| updated_at | datetime | Data e hora da última atualização do fluxo |
| is_ultra | boolean | Define se o fluxo é Ultra ou normal |
| original_pipe_id | int ou NULL | Para fluxos Ultra, define de qual fluxo normal foi copiado originalmente |
| pipe_stages_count | int | Exibe quantas etapas (colunas) este fluxo tem cadastradas |
| vacancies_count | int | Exibe em quantas vagas este fluxo está associado |
| manager | object | Demonstra dados do manager que criou o fluxo |
Updated 3 months ago
