---
title: "Get WhatsApp logs"
method: GET
path: "/whatsapp/logs"
tags: ["WhatsApp"]
---

# Get WhatsApp logs

`GET /whatsapp/logs`

## Request

- Base URL: `https://cpaas.zoho.com/v1.1`
- URL: `https://cpaas.zoho.com/v1.1/whatsapp/logs`
- Auth: API key in header `Authorization`

Returns the agent's WhatsApp message logs, newest first, with pagination and filtering by delivery attributes (status, recipient, sender number) and request attributes (client reference, template, request id, date range). 
Requires an API token with the WhatsApp scope. Rate limited to 40 requests per minute.

## Query parameters

- `offset` integer
- `limit` integer
- `status` string
- `recipient` string
- `client_reference` string
- `template_key` string
- `request_id` string
- `date_from` string, date-time
- `date_to` string, date-time

## Response `200`

WhatsApp logs retrieved successfully.

- WhatsAppLogsResponse: Response containing a page of WhatsApp message logs.
  - `metadata` object
    - `offset` integer
    - `count` integer: Number of entries in this page.
  - `data` WhatsAppLogEntry[]
    - `message_id` string, uuid: Unique identifier of the message.
    - `request_id` string: Identifier of the send request.
    - `client_reference` string: Client reference supplied at send time, if any.
    - `template_key` string, uuid: Key of the WhatsApp template used.
    - `agent_id` string: Identifier of the sending agent.
    - `channel_id` string: Identifier of the WhatsApp channel the message was sent through.
    - `channel_name` string: Name of the WhatsApp channel.
    - `waba_id` string: WhatsApp Business Account id of the channel.
    - `from` string: Sender phone number, with country code.
    - `to` string: Recipient phone number, with country code.
    - `status` string: Message status (e.g. `delivered`, `read`, `sent`, `undelivered`, `failed`, `process_failed`).
    - `process_state` string: Processing state of the request.
    - `remote_ip` string: IP address the send request was made from.
    - `is_batch_request` boolean
    - `request_time` string: When the send request was received (ISO 8601).
    - `time_taken` integer: Processing time in milliseconds.
  - `status` string

## Other responses

- `401`: Access Denied (`TM_4001`) - missing or invalid API token. Please check the authorization details and try again.

---

[API](https://skmtc.dev/zoho/apis/zoho-cpaas.md) - [All operations](https://skmtc.dev/zoho/apis/zoho-cpaas/llms.txt) - [OpenAPI document](https://skmtc.dev/zoho/apis/zoho-cpaas/revisions/f0858a38e8b0?raw)