Listar pessoas

get

https://api.pipe.run/v1/persons

Endpoint de lista de dados

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint utilizado para listar todos os registros de pessoas cadastradas na conta do CRM PipeRun.

Query Params

show

int32

Número de itens na página de resultado.

cursor

string

Defaults to ""

Hash da próxima página.

sort

string

Critérios de ordenação (ASC / DESC).

int32

Filtrar pelo ID da pessoa.

company_id

int32

Filtrar pelo ID do registro da empresa da pessoa.

city_id

int32

Filtrar pelo ID da cidade da pessoa.

manager_id

int32

Filtrar pelo ID do usuário CS responsável pela pessoa.

cpf

string

Filtrar pelo CPF da pessoa. Formatos aceitos: 123.456.789-01, 12345678901.

name

string

Filtrar pelo nome da pessoa.

job_title

string

Filtrar pelo título do cargo da pessoa.

observation

string

Filtrar pelas observações do registro da pessoa.

customer_at

date

Filtrar pela data em que a pessoa se tornou cliente.

external_code

string

Filtrar pelo código externo da pessoa.

status

boolean

Filtrar pelo status do registro da pessoa: 0: desativado, 1: ativado.

created_at_start

date

Filtrar por registros de pessoas cadastradas a partir da data e hora informada.

created_at_end

date

Filtrar por registros de pessoas cadastradas até a data e hora informada.

updated_at_start

date

Filtrar por registros de pessoas atualizadas a partir da data e hora informada.

updated_at_end

date

Filtrar por registros de pessoas atualizadas até a data e hora informada.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404