List brands

GET

/v1/brands

const url = 'https://api.optizmo.com/deploy/v1/brands?page=1&pageSize=200&sort=name';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.optizmo.com/deploy/v1/brands?page=1&pageSize=200&sort=name' \
  --header 'Authorization: <Authorization>'

Lists the brands in your account, one page at a time, sorted by name. Disabled brands are included with enabled: false.

The list can be filtered by name. See the name parameter for the available filter operators. Filter values are matched literally; there is no support for regex or other search syntax.

Authorizations

optizmo_api_key

Parameters

Query Parameters

page

integer

default: 1 >= 1

1-based page number.

pageSize

integer

default: 200 >= 10 <= 200

Number of brands per page.

sort

string

default: name

Allowed values: name -name

Sort by name, ascending (name) or descending (-name).

enabled

boolean

Return only enabled (true) or only disabled (false) brands. Both are returned when omitted.

name

string

Brand name to match. By default this behaves the same as name[equal].

Optional filter operators can be provided in bracket notation to refine the search (at most one name filter per request):

name[equal]: name matches exactly
name[not_equal]: name does not match exactly
name[starts_with]: name starts with the value
name[ends_with]: name ends with the value
name[contains]: name contains the value
name[starts_with_case_sensitive]: case-sensitive starts_with
name[ends_with_case_sensitive]: case-sensitive ends_with
name[contains_case_sensitive]: case-sensitive contains

Responses

200

One page of brands.

application/json

One page of the account’s brands.

object

data

required

Array<object>

object

required

The brand id accepted by the contact subscriptions endpoints and by POST /deploy/v1/contacts’ brandIds field.

string format: uuid

name

required

string

enabled

required

boolean

pagination

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 10 <= 200

totalCount

required

The number of brands matching the request across all pages.

integer

totalPages

required

The total number of pages.

integer

Example

{
  "data": [
    {
      "name": "Acme"
    }
  ]
}

400

A query parameter fails validation, an unknown name filter operator was provided, or more than one name filter was given.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Examples

A query parameter fails validation

{
  "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "pageSize must not be greater than 200",
  "code": "invalid_request_error",
  "instance": "/deploy/v1/brands?pageSize=201",
  "errors": [
    {
      "detail": "pageSize must not be greater than 200"
    }
  ]
}

Unrecognised name filter operator

{
  "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "Unknown name filter operator in \"name[invalid]\"",
  "code": "invalid_request_error",
  "instance": "/deploy/v1/brands?name[invalid]=acme",
  "errors": [
    {
      "detail": "Unknown name filter operator in \"name[invalid]\"",
      "parameter": "name[invalid]"
    }
  ]
}

More than one name filter provided

{
  "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "Provide at most one name filter",
  "code": "invalid_request_error",
  "instance": "/deploy/v1/brands?name=acme&name[contains]=ac",
  "errors": [
    {
      "detail": "Provide at most one name filter",
      "parameter": "name"
    }
  ]
}

401

Missing or invalid API key.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.optizmo.com/deploy/error-codes#authentication_error",
  "status": 401,
  "title": "Authentication failed",
  "detail": "credentials required",
  "code": "authentication_error",
  "instance": "/deploy/v1/contacts"
}

403

Permission denied.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.optizmo.com/deploy/error-codes#permission_error",
  "status": 403,
  "title": "Permission denied",
  "detail": "api key required",
  "code": "permission_error",
  "instance": "/deploy/v1/contacts"
}