Skip to main content
Brands

List all brands

Returns all brands in your organization with cursor-based pagination.

GET
/v2/brands

Query Parameters

  • limit - Number of brands to return (1-100, default: 10)
  • cursor - Opaque cursor from a previous response for pagination

Response Structure

The response includes:

  • object - Always "list"
  • data - Array of brand objects
  • nextCursor - Cursor for the next page (null if no more results)

Brand Object

Each brand includes:

  • id - Featurebase internal ID (MongoDB ObjectId)
  • name - Brand display name
  • isDefault - Whether this is the default brand
  • createdAt - Creation timestamp
  • updatedAt - Last update timestamp
  • helpCenterId - Associated help center ID
  • senderEmailAddressId - Default sender email address ID

Example Response

{
  "object": "list",
  "data": [
    {
      "object": "brand",
      "id": "507f1f77bcf86cd799439011",
      "name": "Default Brand",
      "isDefault": true,
      "createdAt": "2025-01-01T12:00:00.000Z",
      "updatedAt": "2025-01-10T15:30:00.000Z",
      "helpCenterId": "11",
      "senderEmailAddressId": "507f1f77bcf86cd799439012"
    }
  ],
  "nextCursor": null
}

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

limitintegerquerydefault:10

A limit on the number of brands to be returned, between 1 and 100.

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of brands

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team