Get a brand

List all brands available at organization-level

List all brands available at organization-level. 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/organizations/{organizationId}/tcr-brands

Authorization

useraccessKey

Path parameters

organizationId*OrganizationId (string (uuid))

The ID for the organization.

Example: "d0b85ccc-b63a-4e81-b698-c359d77d250e"

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. To know more, refer to the pagination section.

results*array of OrganizationTCRBrand (all of)

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/tcr-brands', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-12-21T12:00:40.041Z",
      "updatedAt": "2024-12-21T12:00:40.041Z",
      "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",
      "businessContactEmail": "[e-mail]",
      "businessContactEmailVerifiedDate": "2024-12-21T12:00:40.041Z",
      "workspaceIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "rejection": {
        "description": "text",
        "code": "text"
      }
    }
  ]
}

Type	Description
BrandReponse	BrandResponse object describes a submitted brand