Query Tenant Page Branding Override Toggles

get

https://{application_vanity_domain}/api/v1/tenants/{tenantId}/page-branding-override-toggles

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Queries page branding override toggles, scoped by tenant, according to a specified query expression:

Query Filter Attributes

Name	Type	Case Sensitive	Supported Comparison Operators
`status`	String	No	eq, ne, in, nin

Sort Attributes

status

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

Permission	Boundary	Description
page-branding:read	Application	The subject can perform this query if the tenant specified in the URL path is associated with the subject's application.
	Tenant	The subject can perform this query if they are associated with the tenant specified in the URL path.
	Tenant Inclusion List	The subject can perform this query if the tenant specified in the URL path is included in the tenant inclusion list.
	Tenant Exclusion List	The subject can perform this query if the tenant specified in the URL path belongs to the subject's associated application and is not included in the tenant exclusion list.

Path Params

tenantId

string

required

length between 1 and 26

The ID of the tenant that the resource or action is scoped to.

Query Params

query

string

length ≥ 0

Defaults to ""

Query expression used to filter returned results in a query API call.

sort_by

string

List of attributes that the results of a query should be sorted by along with their corresponding sort orders. The items that occur earlier in the list will have higher sorting precedence than those that occur later in the list.

start_index

number

≥ 1

Defaults to 1

A 1-based index indicating the position of the first item that should be returned in the query response.

count

number

≥ 0

Defaults to 20

The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched.

fields

string

length ≥ 0

Defaults to *

List of resource fields that should be returned in a response. The wildcard value of * can be used to return all fields for the resource.

Responses

Query Filter Attributes

Sort Attributes

Required Permissions

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

500Internal Server Error

503Service Unavailable