Docs
Open dashboard

List opt-outs

GET/sms/opt-outs

Returns the workspace's unsubscribe list, newest first. Numbers on it are never texted by campaigns, automations or this API.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Query parameters

  • pageinteger≥ 1optional
    1-based page index. Defaults to 1.
    Default 1
  • page_sizeinteger1–100optional
    Items per page. Defaults to 20. Hard-capped at 100 by the server.
    Default 20
  • searchstringoptional
    Match on part of a number. Formatting is ignored.

Response 200 OK

Paginated opt-out list.

  • dataobject[]required
    5 fields
    • idstringuuidoptional
    • phone_numberstringoptional
      Stored as digits only.
    • sourcestringoptional
      How the number got here. stop_keyword (the contact texted STOP), manual (added in the app) or api.
    • campaign_idstringnullableuuidoptional
    • created_atstringdate-timeoptional
  • paginationobjectrequired
    Echoed pagination block on every list response. page and page_size match the request (or the defaults if omitted); total is the count of matching rows across all pages.
    3 fields
    • pageinteger≥ 1required
      1-based page index of this response.
    • page_sizeinteger≥ 1required
      Number of items per page (request cap is 100).
    • totalinteger≥ 0required
      Total matching items across all pages.

Errors

  • 401Unauthorized
    Missing, malformed, or invalid API key.
  • 403Forbidden
    Workspace unavailable, suspended, or paywalled.
  • 429Too Many Requests
    Workspace request limit exceeded; shared across all its API keys.