Skip to main content
GET
Get a team

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

Path Parameters

teamId
string
required

The team (group) id to fetch.

Response

Success. Empty result sets are also 200.

A single team with its full member list.

id
string
required
customerId
string
required
name
string
required
members
object[]
required
tags
string[]
monthlyCreditLimit
number

Credits all of the team's agents may use together per calendar month. Absent means none.

capabilityAdminSettings
object

Which capabilities agents may use, and the default for capabilities with no explicit entry.

documentWriteAccess
object
notificationSettings
object
{key}
any