Listar pessoas

Retorna uma página de pessoas da inbox informada, com suporte a filtros por nome, e-mail, bloqueio e tags.

GET /people

Listar pessoas

cURL

curl --request GET \
  --url http://localhost:3001/people/ \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "imageUrl": "<string>",
      "phoneNumber": "<string>",
      "document": "<string>",
      "description": "<string>",
      "country": "<string>",
      "city": "<string>",
      "isBlocked": true,
      "inboxId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "conversationId": "<string>",
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

Insira o token JWT no formato: Bearer {token}

Query Parameters

inboxId · string · required

Filtra pessoas pertencentes a esta caixa de entrada (obrigatório).

name · string

Busca por nome (parcial, ignorando acentuação) ou, se o texto contiver dígitos, também por trechos do telefone.

email · string<email>

Filtro por trecho de e-mail (correspondência parcial, sem diferenciar maiúsculas).

isBlocked · boolean

Filtra por status de bloqueio (true / false), aceito como string ou booleano na query.

page · string number

Número da página (base 1).

limit · string number

Quantidade máxima de itens por página.

tags · string string[]

Filtra por uma ou mais tags (ID ou lista de IDs, conforme envio na query).

Response

200

application/json

Default Response

data · object[] · required

Lista de pessoas da página atual.

Show child attributes

totalResults · number · required

Total de registros que atendem aos filtros (todas as páginas).

totalPages · number · required

Quantidade total de páginas para o limit atual.