Skip to main content
Create 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.

Body

application/json
name
string
required
Required string length: 1 - 100
user_ids
string[]

Every member of the team; replaces its members. Each must be in the organization.

Maximum array length: 100
Required string length: 1 - 255
access_limit
object | null

What the team's members may see. Null or omitted: the team changes nothing about what its members see.

is_ap_team
boolean

Whether this is the AP team, which owns Inbox work (getting invoices ready, choosing approvers, resolving rejections in the accounting system). One team per organization; its members always see every invoice and can edit, so it takes no access limit and no restricted or read-only members.

allow_no_access
boolean

Save even when the change leaves a non-Admin member nothing to see. Without it, such a change returns 409 no_access_left naming them.

Response

The created 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.