---
title: "List USSD OTPs"
method: GET
path: "/v1/ussd-otps"
tags: ["USSD OTP"]
---

# List USSD OTPs

`GET /v1/ussd-otps`

Retrieves a list of USSD OTP sessions with optional filtering and pagination.

## Query parameters

- `limit` integer — Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.
- `after` string, nullable — Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

## Headers

- `Monime-Version` 'caph.2025-08-23' | 'caph.2025-06-20', nullable — Specifies which version of the Monime API will handle this request.
- `Monime-Space-Id` string, required — The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

## Response `200`

OK

- object
  - `success` boolean — Represents the status of the query operation, confirming if it was successful. This field is always true
  - `messages` unknown[] — Contains a list of messages providing relevant information or feedback related to the query or operation
    - unknown
  - `result` UssdOtp[], nullable — The list of items in the response
    - `id` string — **Unique identifier** for this USSD OTP session.
    - `status` 'pending' | 'verified' | 'expired' — **Status** of the OTP session. One of: - pending: Awaiting verification. - verified: OTP was successfully confirmed. - expired: OTP expired before verification.
    - `dialCode` string — **USSD dial code** that the user should dial (e.g., \*715\*12345#) to initiate the OTP verification.
    - `authorizedPhoneNumber` string — **Authorized phone number** (MSISDN) associated with this OTP. May be masked for privacy.
    - `verificationMessage` string, nullable — **Message** shown to the user after successful verification, typically rendered on the USSD interface.
    - `createTime` string, date-time — Timestamp when this OTP session was created.
    - `expireTime` string, date-time — **Expiration time** after which the OTP becomes invalid.
    - `metadata` object, nullable — **Optional metadata** for attaching additional context or tracking info to this OTP session.
  - `pagination` object — The pagination info associated with the response
    - `count` integer — Number of items returned in the current page.
    - `next` string, nullable — Cursor pointing to the next page of results. Use this value as the 'after' query parameter in your next request to fetch the following page. If null, you have reached the end of the result set.

---

[API](https://skmtc.dev/monime/apis/monime-api.md) · [All operations](https://skmtc.dev/monime/apis/monime-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/monime/monime-api/revisions/bd7f875ea428/schema)
