Custom Branding

Fetch Custom Branding Settings

Retrieve custom branding information for the current user's account.

This endpoint returns structured Custom Branding (Private Label) objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the private_label top-level JSON key. Please see our Response Format section for more information.

Request

query Parameters

only	string Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like `GET /api/v1/workspaces.json?only=5,6,7`.
page	integer <int32> Default: 1
per_page	integer <int32> <= 200 Default: 20

Responses

200

A list of Custom Branding (Private Label)s have been retrieved.

Response Schema: application/json

count	integer <int32>
	object
	Array of objects
	object

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/custom_branding

Request samples

Response samples

application/json

{"count": 0,
"meta": {"count": 0,
"page_count": 0,
"page_number": 0,
"page_size": 0
},
"results": [{"key": "string",
"id": "string"
}
],
"private_label": {"property1": {"business_name": "string",
"button_color": "string",
"created_at": "2019-08-24T14:15:22Z",
"custom_login_message": "string",
"header_color": "string",
"left_nav_background_color": "string",
"left_nav_button_color": "string",
"link_color": "string",
"logo_url": "string",
"state": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"property2": {"business_name": "string",
"button_color": "string",
"created_at": "2019-08-24T14:15:22Z",
"custom_login_message": "string",
"header_color": "string",
"left_nav_background_color": "string",
"left_nav_button_color": "string",
"link_color": "string",
"logo_url": "string",
"state": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

➔ Next to Organization Memberships