Retornar pessoas

get

https://api.proesc.com/api/v2/people

Retorna uma listagem de pessoas cadastradas na instituição

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

unit_id

string

Id da unidade para filtragem das informações .

page

integer

≥ 1

Número de página para listagem de dados

limit

integer

1 to 50

Defaults to 20

The numbers of items to return.

integer

Identificador único da pessoa, para busca exata.

cpf

string

CPF da pessoa, para busca exata. Aceita o valor formatado
(ex: "386.001.258-47") — a pontuação é removida automaticamente antes da busca.

name

string

Nome da pessoa para busca. A busca é feita via full-text search (acento-insensível,
por prefixo), não uma busca exata.

string

E-mail da pessoa, para busca exata.

group_id

integer

Identificador único do grupo, para filtrar pessoas vinculadas a ele.

string

Busca textual legada por nome (full-text search).

registration_start_date

date

Data inicial de cadastro da pessoa (pessoas.created_at), no formato "YYYY-MM-DD".
Se informado sozinho, retorna apenas os registros cadastrados nesse dia. Se informado
junto de "registration_end_date", retorna os registros cadastrados dentro do intervalo
(inclusive).

registration_end_date

date

Data final de cadastro da pessoa (pessoas.created_at), no formato "YYYY-MM-DD".
Se informado sozinho, retorna apenas os registros cadastrados nesse dia. Se informado
junto de "registration_start_date", retorna os registros cadastrados dentro do intervalo
(inclusive).

Responses

400

Entrada inválida

Language

Credentials

Header

Loading…

Response

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

application/json

200Resposta válida