Gateway-API
  1. Contacts
Gateway-API
  • Gateway - API
    • Contacts
      • List
        GET
    • Routes
      • Routes
    • Reports
      • Received Messages Report
      • Sent Messages Report
    • RCS
      • Send RCS (File) Message
      • Send RCS (Carrossel) Message
      • Send RCS (Card) Message
      • Send RCS (Basic) Message
    • SMS
      • Send SMS Message
    • Schemas
      • Core
        • CoreResult
      • Contacts
        • Contact
      • Routes
        • Routes
      • Reports
        • Received
        • Sent
      • RCS
        • Send RCS File
        • Send RCS Basic
        • Send RCS carousel
        • Send RCS card
      • SMS
        • Send Sms
  • Default module
    • Raiz
  1. Contacts

List

GET
/contacts
Este endpoint retorna a lista de grupos de contatos cadastrados na conta do cliente autenticado. Os grupos de contatos permitem organizar listas de destinatários que podem ser utilizadas para envios em massa de mensagens SMS ou RCS, facilitando campanhas segmentadas e comunicações recorrentes.
Cada grupo inclui informações como nome, data de criação e quantidade de contatos válidos prontos para envio.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/contacts' \
--header 'x-api-key: <api-key>'
Response Response Example
{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": [
        {
            "id": 0,
            "name": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "validContacts": 0
        }
    ]
}
Modified at 2025-11-06 13:48:03
Next
Routes
Built with