Listar Aceites via WhatsApp V3

Esta é uma requisição GET para /api/v3/acceptance_term/whatsapps.

GET /api/v3/acceptance_term/whatsapps HTTP/1.1
Host: sandbox.clicksign.com
Accept: application/vnd.api+json
Authorization: {{access_token}}

Filtros disponíveis

Parâmetro	Descrição	Exemplo
`filter[status]`	Filtra pelo status do Aceite valores: `enqueued, sent, completed, canceled, refused, expired e error.`	`?filter[status]=sent`

Ordenação

Parâmetro	Descrição
`sort=created`	Ordena por data de criação (crescente)
`sort=-created`	Ordena por data de criação (decrescente)

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign.

Exemplo completo

Request

GET /api/v3/acceptance_term/whatsapps?filter[status]=sent&sort=-created HTTP/1.1
Host: sandbox.clicksign.com
Accept: application/vnd.api+json
Authorization: {{access_token}}

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json; charset=utf-8

{
  "data": [
    {
      "id": "037f797b-b472-4258-b0a2-261f7c86e218",
      "type": "acceptance_term_whatsapps",
      "attributes": {
        "title": "Alteração Plano Internet",
        "sender_name": "Fernando Silva (Clicksign)",
        "sender_phone": "55999078674",
        "sender_name_option": "user_and_account_name",
        "message": "Eu, Fulano declaro que fui informado sobre a mudança de plano.",
        "signer_phone": "55999078674",
        "signer_name": "Alice Example",
        "status": "sent",
        "status_flow": "waiting_acceptance",
        "sent_at": "2025-11-27T12:05:00.000Z",
        "created": "2025-11-27T12:00:00.000Z",
        "modified": "2025-11-27T12:05:00.000Z"
      }
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "acceptance_term_whatsapps",
      "attributes": {
        "title": "Termo de Aceite Contrato",
        "sender_name": "Clicksign",
        "sender_phone": "11999999999",
        "sender_name_option": "account_name",
        "message": "Por favor, aceite os termos do contrato.",
        "signer_phone": "11888888888",
        "signer_name": "Maria Santos",
        "status": "sent",
        "status_flow": "waiting_acceptance",
        "sent_at": "2025-11-26T10:30:00.000Z",
        "created": "2025-11-26T10:00:00.000Z",
        "modified": "2025-11-26T10:30:00.000Z"
      }
    }
  ],
  "meta": {
    "record_count": 2
  },
  "links": {
    "first": "/api/v3/acceptance_term/whatsapps?page[number]=1&page[size]=20",
    "last": "/api/v3/acceptance_term/whatsapps?page[number]=1&page[size]=20"
  }
}

Atributos do retorno

Atributo	Descrição	Exemplo
`id`	Chave única do Aceite via WhatsApp.	"037f797b-b472-4258-b0a2-261f7c86e218"
`title`	Nome/Título do Aceite.	"Alteração Plano Internet"
`sender_name`	Nome do remetente que se identificou para o destinatário. Derivado automaticamente de `sender_name_option`.	"Fernando Silva (Clicksign)"
`sender_phone`	Telefone do remetente para contato.	"55999078674"
`sender_name_option`	Opção utilizada para definir o nome do remetente. Valores: `user_name`, `account_name`, `user_and_account_name`	"user_and_account_name"
`message`	Conteúdo do Aceite.	"Eu, Fulano declaro que..."
`signer_phone`	Telefone do destinatário que recebeu o Aceite.	"55999078674"
`signer_name`	Nome do destinatário que recebeu o Aceite.	"Alice Example"
`status`	Status do Aceite. Valores: `enqueued`, `sent`, `completed`, `canceled`	"sent"
`status_flow`	Fluxo de status detalhado do Aceite.	"waiting_acceptance"
`sent_at`	Data em que o Aceite foi enviado via WhatsApp.	"2025-11-27T12:05:00.000Z"
`created`	Data de criação do Aceite.	"2025-11-27T12:00:00.000Z"
`modified`	Data da última modificação do Aceite.	"2025-11-27T12:05:00.000Z"

Metadados

Campo	Descrição
`meta.record_count`	Total de registros encontrados.
`links.first`	Link para a primeira página de resultados.
`links.last`	Link para a última página de resultados.