Skip to main content
GET
List the team

Authorizations

Authorization
string
header
required

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

Response

The team

id
string<uuid>
required

The agent's or member's id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind
enum<string>
required
Available options:
agent,
member
name
string | null
required
email
string | null
required

The agent's primary email address, or the member's

phone
string | null
required

The agent's primary phone number, or the one a member added to their profile

addresses
object[]
required

Where to reach them: the agent's primary address on each channel it has one on, or the member's email address and phone number

icon
enum<string> | null
required

The agent's icon; null for members

Available options:
bot,
sparkles,
bug,
message-square,
headphones,
search,
file-text,
mail,
calendar,
chart-line,
code,
git-pull-request,
database,
shield,
megaphone,
rocket,
wrench,
zap
imageUrl
string | null
required

The member's picture from their sign-in profile, or the avatar it makes them; null for agents

role
enum<string> | null
required

The member's role in the workspace; null for agents

Available options:
admin,
member
listening
boolean | null
required

Whether a client or webhook hears the agent now, so a message at its Message URL reaches it; null for members