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

Query Parameters

integer

page

Required

Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer

pageSize

Required

Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

This response body class contains all of the following: InlineBrandingThemeResourceCustomLinks0 , 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"
        }
    ]
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/brandingThemes/{brandingThemeId}/customLinks?page=value&pageSize=v

Availability

Added in 39.0

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Branding Theme Operations

GET