---
title: "GET /api/customers/sms-usage"
method: GET
path: "/api/customers/sms-usage"
tags: ["Customers"]
---

# GET /api/customers/sms-usage

`GET /api/customers/sms-usage`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/customers/sms-usage`
- Auth: HTTP bearer

## Query parameters

- `organizationId` integer

## Response `200`

Successful response

- object
  - `total` integer, required: SMS this calendar month over all customers.
  - `customers` object[], required
    - `publicId` string, uuid, required
    - `name` string, required
    - `status` 'active' | 'inactive', required
    - `smsUsageCurrentMonth` integer, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)