CMSResponse<T> carries the envelope and Data is the endpoint’s own generated model, so nothing needs deserializing by hand.
Every method on this page is listed with its parameters and types on the methods page.
What the SDK gives you
- One method per operation. Every endpoint in the API reference has a method, and each method’s name, arguments and return shape come from the spec.
- A typed response.
CMSResponse<T>carries the envelope andDatais the endpoint’s own generated model, so nothing needs deserializing by hand. - A result object, not an exception. By default a failed call comes back as a value with
okfalse, so batch work does not need atry/catcharound every request. The facade is optional — the same client works with any DI container.
How it is organized
The client groups methods by resource, so a call reads the same way as the route it calls:cms is the client you initialized, and each segment after it is a resource followed by a method. The
full list of resources and every method under them is on the methods page.
Authentication
The API key is the only credential. It is sent as thex-api-key header on every request, and it is the only
header the SDK sets — there is no header parameter and no hook for adding one. The gateway handles tenant routing
and service status itself.
Where to go next
- Install and use — initialize the client and make your first call.
- Methods — every method, with its parameters and types.
- Errors and rate limits — what each status code means and how to back off.

