# List brands for a project

List existing brands according to the specified filters.

Endpoint: GET /v1/projects/{projectId}/us/brands
Version: 1.0.0
Security: OAuth2

## Path parameters:

  - `projectId` (string, required)
    Customer's project id

## Query parameters:

  - `status` (array)
    The brand status to filter the brands.

  - `displayName` (string)
    Filter brands by brand name.

  - `channelName` (string)
    Filter by specific channel available.
    Enum: "RCS", "SHORT_CODE", "TENDLC"

  - `contentProvider` (boolean)
    Optional boolean flag to filter by content provider. If true, it returns content providers. If false, it returns standard brands. Default is false.

  - `sort` (string)
    Sorting of the results using SQL-like syntax: comma-separated field names with an optional ':desc' or ':asc' suffix. Fields that support sorting are 'displayName', 'status', 'createTime', 'updateTime'. Defaults to ascending order when no suffix is provided.
    Example: "displayName,status:desc"

  - `pageSize` (integer)
    Size of the page to be returned. Default is 20. Maximum is 100.
    Example: 20

  - `pageToken` (string)
    Page token to request subsequent pages when using pagination. This should be the value generated by the system in a previous list request.

## Response 200 fields (application/json):

  - `brands` (array)
    List of brands

  - `brands.brandId` (string)
    The unique identifier for the brand.

  - `brands.displayName` (string)
    The name of the brand. DisplayName must be unique per projectId and marketCode (US)

  - `brands.status` (string)
    Brand status, it can be DRAFT, ACTIVE and ARCHIVED.
    Enum: "DRAFT", "ACTIVE", "ARCHIVED"

  - `brands.channels` (array)
    Channels available for this Brand

  - `brands.createTime` (string)
    The date and time when the brand was created.

  - `brands.updateTime` (string)
    The date and time when the brand was updated.

  - `links` (object)
    Pagination links.

  - `links.next` (string)
    Link to the next page of results, following RFC 8288. Absence of this link indicates the last page.

  - `meta` (object)
    Pagination metadata.

  - `meta.totalCount` (integer)
    Total count of resources matching the provided search criteria. This field cannot be null; an empty result will return 0.

## Response 401 fields (application/problem+json):

  - `type` (string, required)
    A URI reference that identifies the problem type. This URI reference should provide a human-readable explanation of the problem type when dereferenced.

  - `title` (string, required)
    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for localization purposes.

  - `body` (object) — one of:
    - variant 1:
      - `errors` (array)
        Detailed information about the error. This field can contain multiple error details to provide more context about the error that occurred.
      - `errors.pointer` (string)
        JSON pointer to the field that caused the error, following RFC 6901.
      - `errors.detail` (string)
        A human-readable explanation specific to this occurrence of the problem. Like title, this field is not intended for end users, but rather for developers to understand the details of the error that occurred.
    - variant 2:
      - `detail` (string)
        A human-readable explanation of the error that occurred.