Pular para o conteúdo principal
GET
/
api
/
v1
/
contact-groups
Listar grupos de contatos com filtros
curl --request GET \
  --url https://6827d740d717.ngrok-free.app/api/v1/contact-groups \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "contactCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<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 grupo

​
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 grupos

​
id
string
obrigatório

ID único do grupo

​
name
string
obrigatório

Nome do grupo de contatos

​
contactCount
number
obrigatório

Número de contatos no grupo

​
createdAt
string<date-time>
obrigatório

Data de criação

​
description
string

Descrição do grupo

​
updatedAt
string<date-time>

Data de atualização