Skip to main content
Get a team

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields; use dots for nested fields, such as members.user_id. id is always returned. Fields: id, name, members, access_limit, is_ap_team, created_at, updated_at.

Response

The team.

id
string<uuid>
required
name
string
required
members
object[]
required
is_ap_team
boolean
required

Whether this is the AP team: its members own Inbox work and always see every invoice. With no AP team, or none in it, admins own Inbox work.

created_at
string<date-time>
required
updated_at
string<date-time>
required
access_limit
object | null

What the team's members may see; null when the team changes nothing about it. Admins are never limited. Omitted when the caller's own access is limited.