---
title: "List Brand Orders according to the filters applied."
method: GET
path: "/v1/projects/{projectId}/us/orders"
tags: ["orders"]
---

# List Brand Orders according to the filters applied.

`GET /v1/projects/{projectId}/us/orders`

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

## Path parameters

- `projectId` string, required

## Query parameters

- `status` BrandOrderStatus[]
- `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.
- `sort` string
- `pageSize` integer
- `pageToken` string

## Response `200`

OK

- ListBrandOrderResponse — List of Brands response
  - `orders` BrandOrderSummary[] — List of brand orders
    - `brandOrderId` string — The unique identifier for the brand order.
    - `brandId` string — Brand ID this Order belongs to.
    - `status` 'NEW' | 'PENDING' | 'PENDING_REVIEW' | 'REJECTED' | 'INCOMPLETE' | 'COMPLETED' | 'ARCHIVED' — Brand order status represents the current state of the brand order in the system. When a brand order is created, it is in NEW status. After that, it can be moved to PENDING status when the validation process starts, then it can be moved to REJECTED or INCOMPLETE if the validation process fails, or to COMPLETED if the validation process is successful. When a brand order is in INCOMPLETE status, customer can update the brand/brand order. Updating the brand order moves the brand order to PENDING_REVIEW state, what means that is waiting for another review after the customer changes. Finally, a brand order can be moved to ARCHIVED status after a cancellation.
    - `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.
    - `createTime` string, date-time — Create time of the request. ISO date time format in UTC.
    - `updateTime` string, date-time — Update time of the request. ISO date time format in UTC.
  - `links` Links — Pagination links.
    - `next` string — Link to the next page of results, following RFC 8288. Absence of this link indicates the last page.
  - `meta` PaginationMeta — Pagination metadata for list responses.
    - `totalCount` integer — Total count of resources matching the provided search criteria. This field cannot be null; an empty result will return 0.

## Other responses

- `401` — UNAUTHENTICATED: Missing or invalid authentication credentials.
- `403` — PERMISSION_DENIED: The authenticated user does not have permission to perform this operation.
- `404` — NOT_FOUND: The project id introduced does not exist.
- `429` — RESOURCE_EXHAUSTED: Too many requests. The client has exceeded the rate limit.
- `500` — INTERNAL: Internal server error. Typically, a server bug.

---

[API](https://skmtc.net/sinch/apis/sinch-compliance-api-brands.md) · [All operations](https://skmtc.net/sinch/apis/sinch-compliance-api-brands/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/sinch-compliance-api-brands/revisions/fcc788f31a0a/schema)