GET
/
v1
/
teams
/
{teamId}
/
brands
/
{brandId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.brands.getBrand({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  brandId: process.env.OCTOSPARK_BRAND_ID ?? "brandId",
})
{
  "id": "<string>",
  "teamId": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "isPrimary": true,
  "language": "<string>",
  "website": "<string>",
  "businessDescription": "<string>",
  "idealCustomer": "<string>",
  "customerLocation": "<string>",
  "colors": {
    "primary": "<string>",
    "secondary": "<string>",
    "accent": "<string>",
    "background": "<string>",
    "text": "<string>"
  },
  "contentTopics": [
    "<string>"
  ],
  "selectedSourceIds": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

brandId
string
required

Brand id (UUID), as returned by the list brands and create brand endpoints.

Response

Success

id
string
required
teamId
string
required
organizationId
string
required
name
string
required
isPrimary
boolean
required
language
string | null
required
website
string | null
required
businessDescription
string | null
required
idealCustomer
string | null
required
customerLocation
string | null
required
colors
object
required
contentTopics
string[]
required
selectedSourceIds
string[]
required
createdAt
string
required
updatedAt
string
required