No-code docs
Resources

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

Authorizations
Path parameters
organizationIdstring · uuidrequired

The ID for the organization.

Example: d0b85ccc-b63a-4e81-b698-c359d77d250e
Query parameters
limitinteger · min: 1 · max: 99 · default: 10

Limits the number of results to return per page. The default value is 10 and maximum is 99. If the nextPageToken is defined on response, you can use it to get remaining numbers. To know more, refer to the pagination section.

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list. Use it to query remaining results. If not provided, the first page is returned. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.

reverseboolean

Order in which to retrieve the results. By default, the orders are in ascending order date. To get the results in descending order, set this parameter to true.

Responses
curl -L \
  --url '/organizations/{organizationId}/tcr-brands' \
  --header 'Authorization: Bearer jwt'
{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-21T18:23:31.465Z",
      "updatedAt": "2025-02-21T18:23:31.465Z",
      "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",
      "businessContactEmailVerifiedDate": "2025-02-21T18:23:31.465Z",
      "workspaceIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "businessContactEmail": "hello@example.com",
      "rejection": {
        "description": "text",
        "code": "text"
      }
    }
  ]
}

OK

Type
Description

BrandReponse

BrandResponse object describes a submitted brand

Last updated

Was this helpful?