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

id
string | null

Return this one client with its features.

include
string | null

Without id: revenue adds the trailing 30 day overview. With id: a comma list of details (status, plan, owner, health, 30 days of usage and revenue), limits (monthly caps and channel access), audit (what the client did and what you changed) and users (the client's own people).

Response

Successful Response

created_at
string
required

Created at returned by the Sendora API.

id
string
required

The client workspace's public id. Pass it as client_id to the other agency endpoints.

name
string
required

Name returned by the Sendora API.

status
string
required

Status returned by the Sendora API.

billing_mode
enum<string>
default:billing_unavailable

Billing mode returned by the Sendora API.

Available options:
self_managed,
client_prepaid,
billing_unavailable
campaign_count
integer
default:0

Campaign count returned by the Sendora API.

client_billing_status
string | null

Client billing status returned by the Sendora API.

client_package_name
string | null

Client package name returned by the Sendora API.

custom_domain
string | null

Custom domain returned by the Sendora API.

health
string
default:unknown

Health returned by the Sendora API.

is_owner_workspace
boolean
default:false

Is owner workspace returned by the Sendora API.

logo_url
string | null

Logo url returned by the Sendora API.

monthly_revenue
number | null

Monthly revenue returned by the Sendora API.

owner_email
string | null

Owner email returned by the Sendora API.

owner_name
string | null

Owner name returned by the Sendora API.

plan
string | null

Plan returned by the Sendora API.

slug
string | null

Slug returned by the Sendora API.

updated_at
string | null

Updated at returned by the Sendora API.