Sign in
latestOpenAPI 3.0.3MIT2026-08-10102048.8 KB

b49d3ae283fd

brands

List brands for a project

The endpoint receives as path param project id. If the project exists, the list of brands for the project is returned. Additional filters can be applied as query params. By default, ARCHIVED brands are not returned. To include them, the status filter must be used.

get/v1/projects/{projectId}/brands

Path parameters

projectIdstring required

Customer's project id

Query parameters

statusBrandStatus[]

The brand status to filter the brands.

[
  "INCOMPLETE"
]
brandType'US_SHORT_CODE_REGISTRY' enum
Example:US_SHORT_CODE_REGISTRY

The brand metadata type to filter the brands

orderBystring

Ordering of the results: field name with an optional order separated by a comma. Fields that support ordering are 'brandName', 'status', 'createTime', 'updateTime' with possible ordering 'desc' or 'asc'

pageSizeinteger

Size of the page to be returned.

pageTokenstring

Page token to request subsequent pages when using pagination. This should be the value generated by the system in a previous list request.

brandNamestring

Filter brands by brand name.

Response

OK

nextPageTokenstring

Token to request the next page of results.

totalSizeinteger

Total count of brands matching provided search criteria

Example response

[
  {
    "brands": [
      {
        "brandId": "1234567890",
        "brandName": "My End Customer Brand Name",
        "brandMetadataId": "4444444444",
        "status": "INCOMPLETE",
        "callbackUrl": "https://example.com/callback",
        "createTime": "2023-10-01 12:00:00+00:00",
        "updateTime": "2023-10-01 12:00:00+00:00"
      }
    ]
  }
]