Get brand(s)

Lists brands in your organization. Set type=default to return only the default brand, or provide workflowId to return the brand that applies to that workflow. A single-brand lookup returns null when no applicable brand is configured.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 1000
Defaults to 20

Number of items returned per page. Defaults to 20; maximum 1000.

number
≥ 1
Defaults to 1

1-based page number to return. Defaults to 1.

string
enum

Set to default to return the organization default brand instead of a paginated list.

Allowed:
uuid

UUID of a workflow. When provided, returns the brand that currently applies to that workflow instead of a paginated list.

string

Limits the paginated list to brands matching this name.

string
enum
Defaults to desc

Sort order. Use asc for ascending or desc for descending.

Allowed:
string

Comma-separated fields used to order the brand list. Available value: createdAt.

Responses

404

The workflow specified by workflowId was not found.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json