Pular para o conteúdo principal
GET
/
api
/
v1
/
contacts
Listar contatos com filtros
curl --request GET \
  --url https://6827d740d717.ngrok-free.app/api/v1/contacts \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "photoUrl": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Autorizações

​
Authorization
string
header
obrigatório

API Key de autenticação - usar ApiKey {sua-api-key}

Parâmetros de consulta

​
name
string

Buscar por nome do contato

​
phone
string

Buscar por telefone do contato

​
startDate
string

Data de início para filtrar por data de criação

​
endDate
string

Data de fim para filtrar por data de criação

​
page
number
padrão:1

Página para paginação

​
limit
number
padrão:10

Itens por página

Resposta

200 - application/json

Lista de contatos

​
id
string
obrigatório

ID único do contato

​
name
string
obrigatório

Nome do contato

​
phone
string
obrigatório

Número de telefone do contato

​
createdAt
string<date-time>
obrigatório

Data de criação

​
photoUrl
string

URL da foto do contato

​
updatedAt
string<date-time>

Data de atualização