Get Active Custom Links Theme Resource

Gets the custom links for the active theme for the current organization.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/brandingThemes/{brandingThemeId}/customLinks

COPY

Path Parameters

string

brandingThemeId

Required

branding theme URN or 'active' for the current active theme

string

brandingThemeId

Required

branding theme URN or 'active' for the current active theme

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

integer

page

Required

Page to fetch, zero offset.

integer

pageSize

Required

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns BrandingThemeResourceCustomLinks of type(s) application/json;version=37.2

This response body class contains all of the following: Page , InlineBrandingThemeResourceCustomLinks1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "name": "string",
            "linkType": "string",
            "scope": "string",
            "url": "string",
            "order": "number",
            "parentId": "string"
        }
    ]
}

Availability

Added in 38.0.0-alpha

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Branding Theme Operations

POST