---
title: "List SMS usage records"
method: GET
path: "/usage/sms/"
tags: ["SIMs (Devices)"]
---

# List SMS usage records

`GET /usage/sms/`

## Request

- Base URL: `https://dashboard.hologram.io/api/1`
- URL: `https://dashboard.hologram.io/api/1/usage/sms/`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/usage/sms/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer
- `before` integer
- `after` integer
- `simcardid` integer
- `simcardids` string
- `timestart` integer
- `timeend` integer
- `aggregate` 'month' | 'day' | 'hour' | 'billing'
- `startafter` integer
- `maxperiodsback` integer
- `tagid` integer
- `tagname` string
- `usagetype` 'persim' | 'perprofile' | 'simtotal'

## Response `200`

OK

- SMSUsageListResponse
  - `success` boolean: Indicates whether the request was successful.
  - `limit` integer: Maximum number of records returned per page
  - `size` integer: Number of records in this response
  - `continues` boolean: True if more records are available
  - `lastid` integer: record_id of the last record returned; pass as startafter to fetch the next page
  - `links` PaginationLinks
    - `path` string: The API endpoint path
    - `base` string: The API base URL
    - `next` string: URL to retrieve the next page of results
  - `data` SMSUsageRecord[]
    - `linkid` integer: Cellular link (SIM) ID
    - `record_id` integer: Unique SMS record ID, used for cursor-based pagination
    - `timestamp` string: Time the SMS was sent/received (UTC)
    - `direction` string: SMS direction (MT = mobile-terminated/inbound, MO = mobile-originated/outbound)
    - `other_number` string: The external phone number involved in the SMS
    - `sendtime_is_approximate` 0 | 1: 1 if the send time is approximate rather than exact
    - `bootstrap_id` integer: Internal eUICC mapping ID

## Other responses

- `400`: Invalid usagetype or aggregation filter
- `401`: Unauthorized

---

[API](https://skmtc.dev/hologram/apis/hologram-rest-api-v1.md) - [All operations](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/revisions/1bc07dcd1631?raw)