Ir al contenido principal
Brands

Get brand by ID

Retrieves a single brand by its Featurebase ID.

GET
/v2/brands/{id}

Path Parameters

  • id - The Featurebase internal ID of the brand (MongoDB ObjectId)

Response

Returns a brand object with:

  • id - Featurebase internal ID
  • 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": "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"
}

Error Responses

  • 404 Not Found - Brand with the specified ID does not exist

Version Availability

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

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

The Featurebase internal ID of the brand (MongoDB ObjectId)

Ejemplo: 507f1f77bcf86cd799439011

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Ejemplo: 2026-08-19.orbit

Respuesta

application/json

Success

createdAtstring | nullobligatorio

ISO date when brand was created

Ejemplo: 2025-01-01T12:00:00.000Z
helpCenterIdstring | nullobligatorio

The ID of the help center associated with this brand

Ejemplo: 11
idstringobligatorio

Featurebase internal ID

Ejemplo: 507f1f77bcf86cd799439011
isDefaultbooleanobligatorio

Whether this is the default brand

Ejemplo: true
namestringobligatorio

Brand display name

Ejemplo: Default Brand
objectenum<string>obligatorio

Object type identifier

Opciones disponibles: brand
Ejemplo: brand
senderEmailAddressIdstring | nullobligatorio

The ID of the default sending email address for this brand

Ejemplo: 507f1f77bcf86cd799439012
updatedAtstring | nullobligatorio

ISO date when brand was last updated

Ejemplo: 2025-01-10T15:30:00.000Z

¿Aún necesitas ayuda? Pregunta al equipo