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

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

const response = await client.personas.listPersonas({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "displayName": "<string>",
      "dateOfBirth": "<string>",
      "biography": "<string>",
      "careerExperiences": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "summary": "<string>",
          "isCurrent": true,
          "organization": "<string>",
          "industry": "<string>",
          "startedAt": "<string>",
          "endedAt": "<string>"
        }
      ],
      "avatarAttributes": {},
      "selectedElevenLabsVoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 123,
      "archivedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<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.

Query Parameters

cursor
string

Cursor returned by a previous persona list response to fetch the next page.

limit
string

a string to be decoded into a number

sortOrder
enum<string>

Sort direction for persona creation time.

Available options:
asc,
desc

Response

Success

data
object[]
required
total
number
required
nextCursor
string | null
required
prevCursor
string | null
required