---
title: "Retrieve the segment usage for a business"
method: GET
path: "/businesses/{id}/segment_usage"
tags: ["Segment usage"]
---

# Retrieve the segment usage for a business

`GET /businesses/{id}/segment_usage`

## Path parameters

- `id` string, required

## Query parameters

- `start_time` string
- `end_time` string

## Response `200`

The segment usage for the business within the time window

- object
  - `sms` integer, required — The number of SMS segments sent
  - `mms` integer, required — The number of MMS segments sent
  - `email` integer, required — The number of email segments sent
  - `scheduled_segment_usage` object, required — The scheduled segment usage for campaigns not yet sent
    - `sms` integer, required — The number of scheduled SMS segments
    - `mms` integer, required — The number of scheduled MMS segments
    - `email` integer, required — The number of scheduled email segments
  - `in_progress_segment_usage` object, required — The estimated segment usage for in-progress campaigns
    - `sms` integer, required — The number of in-progress SMS segments remaining
    - `mms` integer, required — The number of in-progress MMS segments remaining
    - `email` integer, required — The number of in-progress email segments remaining
  - `start_time` string, required — The start time of the usage period in ISO 8601 format
  - `end_time` string, required — The end time of the usage period in ISO 8601 format

---

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