Sign in
latestOpenAPI 3.1.0MIT2026-08-102135157.7 KB

fcc788f31a0a

brands

List brands for a project

List existing brands according to the specified filters.

get/v1/projects/{projectId}/us/brands

Path parameters

projectIdstring required

Customer's project id

Query parameters

statusBrandStatus[]

The brand status to filter the brands.

[
  "ACTIVE"
]
displayNamestring

Filter brands by brand name.

channelName'RCS' | 'SHORT_CODE' | 'TENDLC'

Channel represents the different channels that can be assigned to a brand after completing a brand order. Each channel has different requirements and it is assigned after completing a specific brand order process.

Example:RCS

Filter by specific channel available.

contentProviderboolean

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

sortstring

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.

pageSizeinteger

Size of the page to be returned. Default is 20. Maximum is 100.

pageTokenstring

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

Response

OK

Example response

{
  "brands": [
    {
      "brandId": "1234567890",
      "displayName": "My End Customer Brand Name",
      "status": "ACTIVE",
      "channels": [
        "RCS"
      ],
      "createTime": "2023-10-01T12:00:00Z",
      "updateTime": "2023-10-01T12:00:00Z"
    }
  ],
  "links": {
    "next": "https://compliance.api.sinch.com/v1/projects/{projectId}/us/brands?pageToken=abc123"
  }
}