List all brands

List brands in workspace

GET/workspaces/{workspaceId}/tcr-brands

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200

OK

Body

application/json

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.

results*array of WorkspaceTCRBrand (object)

Request

JavaScriptCurl

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-04-29T14:20:04.434Z",
      "updatedAt": "2024-04-29T14:20:04.434Z",
      "status": "PENDING",
      "entityType": "PRIVATE_PROFIT",
      "firstName": "John",
      "lastName": "Doe",
      "displayName": "ABC Mobile",
      "companyName": "ABC Inc.",
      "ein": "111111111",
      "einIssuingCountry": "US",
      "phone": "[phone]",
      "street": "123 6th Ave",
      "city": "New York",
      "state": "NY",
      "postalCode": "10001",
      "country": "US",
      "email": "[e-mail]",
      "stockSymbol": "ABC",
      "stockExchange": "NASDAQ",
      "website": "https://example.com",
      "vertical": "RETAIL",
      "altBusinessId": "text",
      "altBusinessIdType": "NONE",
      "workspaceIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "rejection": {
        "description": "text",
        "code": "text"
      }
    }
  ]
}

Type	Description
array<BrandReponse>	BrandResponse object describes a submitted brand