See api-docs Menu

Get Apps Associated with Account Brand

Early Preview

This API is in early preview and may be subject to change. Please contact your account manager if you are interested in trying the Branding API.

Use this API to retrieve all apps that have a brand_id with the same value as the provided brand_id param.








Resource URL

https://<api-domain>/api/2/branding/:brand_id/apps

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

In order to use the Branding API your API Credentials must be created after 21st October 2020.

Content-Type

required

string

Set to application/json.

Resource Parameters

brand_id

required

number

Unique identifier for the branding object.

Sample Responses

{
    {
    "id": 1455,
    "updated_at": "2020-09-11T19:35:08.288Z",
    "name": "Mom Corp",
    "connector_id": 3001,
    "auth_method_description": "SAML2.0",
    "description": "Mom’s Friendly Robot Company",
    "auth_method": 2,
    "created_at": "2020-09-08T22:24:19.551Z",
    "visible": true
    }
}

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

The requested brand id does not exist.

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Branding API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Get Apps associated with Account Brand

curl 'https://<api-domain>/api/2/branding/brands/:brand_id/apps' \
-X GET \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.