---
title: "List WhatsApp notifications"
method: GET
path: "/v1/documents/{documentId}/assignments/{assignmentId}/whatsapp-notifications"
tags: ["Assignments"]
---

# List WhatsApp notifications

`GET /v1/documents/{documentId}/assignments/{assignmentId}/whatsapp-notifications`

## Request

- Base URL: `https://api.assinafy.com.br`
- URL: `https://api.assinafy.com.br/v1/documents/{documentId}/assignments/{assignmentId}/whatsapp-notifications`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

List all WhatsApp notification messages sent for an assignment. The response includes the rendered template text split into `header`, `body` and `buttons` — exactly what the signer would see. In sandbox/stage, WhatsApp messages are simulated (no real delivery) and button URLs include access/verification codes you can use to simulate the signing flow; in production the button URLs are stripped. Requires the `documents:read` OAuth scope.

[Copy as Markdown](https://api.assinafy.com.br/v1/docs/markdown?method=get&path=%2Fv1%2Fdocuments%2F%7BdocumentId%7D%2Fassignments%2F%7BassignmentId%7D%2Fwhatsapp-notifications) [Open in ChatGPT](https://chatgpt.com/?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Fdocuments%252F%257BdocumentId%257D%252Fassignments%252F%257BassignmentId%257D%252Fwhatsapp-notifications%20and%20help%20me%20integrate%20this%20endpoint.) [Open in Claude](https://claude.ai/new?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Fdocuments%252F%257BdocumentId%257D%252Fassignments%252F%257BassignmentId%257D%252Fwhatsapp-notifications%20and%20help%20me%20integrate%20this%20endpoint.)

## Path parameters

- `documentId` string, required
- `assignmentId` string, required

## Response `200`

WhatsApp notifications

- object: Standard success wrapper. Operations add their own `data`.
  - `status` integer: HTTP status code, mirrored in the body.
  - `message` string: Human-readable message; empty on success.
  - `data` WhatsappNotification[]
    - `sent_at` string, date-time: When the message was sent.
    - `header` string
    - `body` string
    - `buttons` object[]
      - `text` string: The button label shown to the signer.
    - `phone_number` string: Recipient phone (E.164).
    - `signer_id` string

## Other responses

- `401`: Missing or invalid credentials.
- `500`: Unexpected server error.

## Changes

- **2026-10-22** `dda5f0d393cb`: 1 breaking
  - the `allOf[subschema #2]/data/items/sent_at` response's property type changed from `integer` to `string`, and format from no format to `date-time` for status `200`

[Operation history](https://skmtc.dev/assinafy/apis/assinafy-api-reference/changes/v1/documents/:documentId/assignments/:assignmentId/whatsapp-notifications/get.md)

---

[API](https://skmtc.dev/assinafy/apis/assinafy-api-reference.md) - [All operations](https://skmtc.dev/assinafy/apis/assinafy-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/assinafy/apis/assinafy-api-reference/revisions/f7da81a5567e?raw)