No-code docs
Resources

List all brands

List all brands for a given workspace.

List all brands for a given workspace. The list can be filtered by brand status. This result is paginated. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.

GET/workspaces/{workspaceId}/tcr-brands
Authorization
Path parameters
workspaceId*WorkspaceId (string (uuid))

The ID for the workspace.

Example: "d386a801-ee8d-4aba-a7e4-78671bd3b11e"
Query parameters
Response

OK

Body
nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display. To know more, refer to the pagination section.

results*array of WorkspaceTCRBrand (object)
Request
const response = await fetch('/workspaces/{workspaceId}/tcr-brands', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-12-21T12:11:50.247Z",
      "updatedAt": "2024-12-21T12:11:50.247Z",
      "status": "PENDING",
      "entityType": "PRIVATE_PROFIT",
      "firstName": "John",
      "lastName": "Doe",
      "displayName": "ABC Mobile",
      "companyName": "ABC Inc.",
      "ein": "111111111",
      "einIssuingCountry": "US",
      "phone": "+12024567890",
      "street": "123 6th Ave",
      "city": "New York",
      "state": "NY",
      "postalCode": "10001",
      "country": "US",
      "email": "johndoe@abc.com",
      "stockSymbol": "ABC",
      "stockExchange": "NASDAQ",
      "website": "https://example.com",
      "vertical": "RETAIL",
      "altBusinessId": "text",
      "altBusinessIdType": "NONE",
      "businessContactEmail": "name@gmail.com",
      "businessContactEmailVerifiedDate": "2024-12-21T12:11:50.247Z",
      "workspaceIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "rejection": {
        "description": "text",
        "code": "text"
      }
    }
  ]
}
Type
Description

array<BrandReponse>

BrandResponse object describes a submitted brand

Last updated