API Reference

Get Plan Requests

get
https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v2/tenants/tenant/tenant-id//plans
Path Params
string
required

Tenant identifier.

Query Params
string

Limit. Default value is 20.

string

Starting after is an object ID that defines your place in the list.

string

Object identifier that defines your place in the list.

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

string

Region.

string

Plan Name.

boolean

Entity is a template.

boolean

Entity is public.

string

External Key.

string

External Key Value.

Response

Updated 7 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago