Sign in
latestOpenAPI 3.1.0MIT2026-08-102135157.7 KB

fcc788f31a0a

orders

List Brand Orders according to the filters applied.

List Brand Orders, according to the filters applied. This endpoint allows filtering over all brands.

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

Path parameters

projectIdstring required

Customer's project id

Query parameters

statusBrandOrderStatus[]

The brand Order status to filter the brand orders.

[
  "INCOMPLETE"
]
metadataName'US_SC_REGISTRY' | 'US_SC_GCH' | 'US_SC_GCH_CONTENT_PROVIDER' | 'US_10DLC_TCR_PRIVATE_BRAND_REGISTRATION' | 'US_10DLC_TCR_PUBLIC_BRAND_REGISTRATION' | 'US_10DLC_TCR_PRIVATE_BRAND_UPDATE' | 'US_10DLC_TCR_PUBLIC_BRAND_UPDATE' | 'US_10DLC_TCR_PRIVATE_MOCK' | 'US_10DLC_TCR_PUBLIC_MOCK' | 'US_10DLC_TCR_SOLE_PROPRIETOR' | 'US_10DLC_TCR_PRIVATE_STANDARD_BRAND_REGISTRATION' | 'US_10DLC_TCR_PRIVATE_ENHANCED_BRAND_REGISTRATION' | 'US_10DLC_TCR_PUBLIC_STANDARD_BRAND_REGISTRATION' | 'US_10DLC_TCR_PUBLIC_ENHANCED_BRAND_REGISTRATION' | 'US_RCS_TCR_PRIVATE_BRAND_REGISTRATION' | 'US_RCS_TCR_PUBLIC_BRAND_REGISTRATION' | 'US_RCS_TCR_UPDATE_ASSETS'

These are the different processes the customers can request to add different channels to the Brand.

Note: US_SC_REGISTRY is only used to retrieve existing brand orders. It cannot be used for new ones.

Example:US_SC_REGISTRY

Filter brand orders by brand registration process metadata name.

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 'metadataName', '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

{
  "orders": [
    {
      "brandOrderId": "212421442412",
      "brandId": "3242343243243",
      "status": "INCOMPLETE",
      "metadataName": "US_SC_REGISTRY",
      "createTime": "2021-11-03T14:30:03Z",
      "updateTime": "2021-11-03T14:30:03Z"
    }
  ],
  "links": {
    "next": "https://compliance.api.sinch.com/v1/projects/{projectId}/us/brands?pageToken=abc123"
  }
}