Skip to main content
GET
/
usage
/
sms
List outbound SMS usage
curl --request GET \
  --url https://dashboard.hologram.io/api/1/usage/sms \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 5,
  "size": 2,
  "continues": false,
  "data": [
    {
      "id": 123456,
      "deviceid": 4020513,
      "orgid": 98268,
      "linkid": 5422976,
      "timestamp": "2025-09-18 14:30:00",
      "body": "Test SMS",
      "destination": "+15551234567",
      "status": "delivered",
      "cost": "0.05"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hologram.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.

You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

​
orgid
integer
Example:

144

​
orgids
string

Comma-separated list of organization IDs.

Example:

"85366,85367"

​
startafter
integer
Example:

102544

​
linkid
number

Single profile (link) ID.

Example:

4567890

​
linkids
string

Comma-separated list of link (profile) IDs.

Example:

"5389720,5608542"

​
tagid
number

Single tag ID.

Example:

101

​
tagids
string

Comma-separated list of tag IDs.

Example:

"101,102,103"

​
timestart
integer

Start of time range in Unix epoch seconds format.

Example:

1767225600

​
timeend
number

End of time range in Unix epoch seconds format.

Example:

1769821199

​
tagname
string

Name of a single tag.

Example:

"Chicago Loop"

​
islive
boolean

Return only activated, active SIMs (e.g. LIVE network states).

​
limit
integer

Maximum number of items to return in a single request. For endpoints that support pagination, use this with corresponding /pages endpoints to manage large result sets.

Example:

50

​
aggregate
boolean

When true, aggregates SMS records rather than paginating by individual record_id.

Response

200 - application/json

List of device-originated SMS messages

​
success
boolean
​
limit
integer
​
size
integer
​
continues
boolean
​
data
object[]