---
title: "Get SMS logs"
method: GET
path: "/sms/logs"
tags: ["SMS"]
---

# Get SMS logs

`GET /sms/logs`

## Request

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

Returns the agent's SMS logs, newest first, with pagination and filtering by delivery attributes (status, recipient, sender name) and request attributes (client reference, template, request id, date range).

## Query parameters

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

## Response `200`

SMS logs retrieved successfully.

- SmsLogsResponse: Response containing a page of SMS logs.
  - `metadata` object
    - `offset` integer
    - `count` integer: Number of entries in this page.
  - `data` SmsLogEntry[]
    - `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 SMS template used.
    - `sender_key` string: Key of the sender the message went out as.
    - `sender_name` string: Name of the sender.
    - `agent_id` string: Identifier of the sending agent.
    - `to` string: Recipient mobile number.
    - `status` string: Message status (e.g. `delivered`, `sent`, `undelivered`, `failed`, `process_failed`, or a detailed telecom/DLT failure code).
    - `process_state` string: Processing state of the request.
    - `remote_ip` string: IP address the send request was made from.
    - `chunks` string: Number of SMS parts the message was split into.
    - `is_batch_request` boolean: Whether the message was part of a batch send.
    - `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)