Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Query Parameters

type
enum<string> | null

brand or campaign; omit for both

Available options:
brand,
campaign
id
string | null

The registration's id: the id from List or read SMS registrations. Send the matching type with it. One registration id; requires type

include
string | null

Comma list: events, numbers, eligible_numbers (needs id)

view
string | null

readiness: can the workspace text yet, the form options, and an optional fee quote

Allowed value: "readiness"
quote
enum<string> | null

With view=readiness: also quote this fee

Available options:
brand,
campaign,
vetting
entity_type
string | null

With quote=brand: the business type

Maximum string length: 40
use_case
string | null

With quote=campaign: the use case

Maximum string length: 60

Response

Successful Response

items
(RegistrationBrand · object | RegistrationCampaign · object)[]
required

Items returned by the Sendora API.

total
integer
required

Total returned by the Sendora API.