Skip to main content
GET
/
v1
/
contacts
Listar contatos
curl --request GET \
  --url https://api.notifique.dev/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "url": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "tags": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

Authorization: Bearer sk_live_xxxxx

Query Parameters

page
string

Página (default 1)

limit
string

Itens por página (default 20, máx 100)

Busca por nome, telefone ou e-mail

tagId
string

Filtrar contatos que têm esta tag

Response

Lista de contatos e paginação.

success
boolean
Example:

true

data
object[]
pagination
object