Dedicated Rentals

List rental history

Returns paginated rental history with optional filters.

get/api/v1/rentals

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/rentals
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Query parameters

pageinteger
limitinteger
servicestring

Filter by service name

status'waiting' | 'received' | 'done' | 'cancelled'

Filter by status

Response

Paginated list of rentals

totalinteger
pageinteger
limitinteger

Example response

{
  "rentals": [
    {
      "rental_id": 12345,
      "status": "received",
      "sms_code": "438271",
      "sms_text": "Your WhatsApp code is 438271. Don't share this code.",
      "received_at": "2026-03-03T14:22:11Z"
    }
  ],
  "total": 142,
  "page": 1,
  "limit": 50
}

Changes

No recorded changes to this operation across all 1 revision of this API.