Teams

All requests use a single endpoint: POST /functions/v1/api with resource: "teams".

Access control

Access varies by action. Team owners and internal admins have full access to all actions. Team members have read-only access to get and members. Any authenticated user can create a team.

Action	Any user	Team member	Team owner	Admin
`get`	No	Yes (read-only)	Yes	Yes
`create`	Yes	—	—	Yes
`update`	No	No	Yes	Yes
`delete`	No	No	Yes	Yes
`members`	No	Yes	Yes	Yes
`invite`	No	No	Yes	Yes
`invitations`	No	No	Yes	Yes
`cancel-invite`	No	No	Yes	Yes
`remove-member`	No	No	Yes	Yes

Only team owners and internal admins can manage invitations and remove members. Regular team members have read-only access to get and members actions only.

Team management workflow

Create a team

Use the create action to set up a new team. The authenticated user automatically becomes the team owner.

Invite members

Use the invite action to send invitations by email. Track pending invitations with the invitations action.

Members accept

Invited users accept the invitation to join the team. Their profile is updated with the team_id.

Manage the team

Use members to view the roster, remove-member to remove users, and cancel-invite to revoke pending invitations.

Get a team

Retrieves a specific team by ID with all team members.

resource

string

required

Must be "teams"

action

string

required

Must be "get"

string

required

The team ID.

Response

success

boolean

data

object

Show properties

team

object

Show properties

number

name

string

brand

string

branding

object

owner_id

string

members

object[]

Show properties

string

full_name

string

avatar_url

string

role

string

Either "Owner" or "Member".

const response = await ApiService.invoke<{
  team: Team;
  members: TeamMember[];
}>({
  resource: "teams",
  action: "get",
  id: "123",
});

Create a team

Creates a new team. The authenticated user automatically becomes the team owner.

resource

string

required

Must be "teams"

action

string

required

Must be "create"

data

object

required

Show properties

name

string

required

Team name.

brand

string

required

Team brand name.

branding

object

Branding configuration (e.g. colors, logos).

Response (status 201)

success

boolean

data

object

Show properties

team

object

The newly created team object.

const response = await ApiService.invoke<{ team: Team }>(
  {
    resource: "teams",
    action: "create",
    data: {
      name: "Marketing Team",
      brand: "ACME Corp",
      branding: { color: "#FF0000" },
    },
  },
  201
);

Update a team

Updates team settings such as name, brand, and branding.

resource

string

required

Must be "teams"

action

string

required

Must be "update"

string

required

The team ID.

data

object

required

Show properties

name

string

Updated team name.

brand

string

Updated brand name.

branding

object

Updated branding configuration.

Response

success

boolean

data

object

Show properties

team

object

The updated team object.

const response = await ApiService.invoke<{ team: Team }>({
  resource: "teams",
  action: "update",
  id: "123",
  data: {
    name: "Updated Team Name",
  },
});

Delete a team

Permanently deletes a team and removes all members.

resource

string

required

Must be "teams"

action

string

required

Must be "delete"

string

required

The team ID.

Response

success

boolean

data

object

Show properties

success

boolean

message

string

Deletion result description.

errors

string[]

Array of any cleanup errors, if applicable.

This permanently deletes the team and removes all member associations.

const response = await ApiService.invoke<{
  success: boolean;
  message: string;
}>({
  resource: "teams",
  action: "delete",
  id: "123",
});

List team members

Retrieves all members of a team.

resource

string

required

Must be "teams"

action

string

required

Must be "members"

string

required

The team ID.

Response

success

boolean

data

object

Show properties

members

object[]

Show properties

string

full_name

string

avatar_url

string

role

string

Either "Owner" or "Member".

count

number

Total number of members.

const response = await ApiService.invoke<{
  members: TeamMember[];
  count: number;
}>({
  resource: "teams",
  action: "members",
  id: "123",
});

Invite a member

Sends a team invitation to an email address.

resource

string

required

Must be "teams"

action

string

required

Must be "invite"

string

required

The team ID.

data

object

required

Show properties

string

required

Email address of the person to invite.

Response (status 201)

success

boolean

data

object

Show properties

invitation

object

The pending invitation object.

const response = await ApiService.invoke<{ invitation: TeamInvitation }>(
  {
    resource: "teams",
    action: "invite",
    id: "123",
    data: {
      email: "user@example.com",
    },
  },
  201
);

List pending invitations

Retrieves all pending invitations for a team.

resource

string

required

Must be "teams"

action

string

required

Must be "invitations"

string

required

The team ID.

Response

success

boolean

data

object

Show properties

invitations

object[]

Array of pending invitation objects.

count

number

Number of pending invitations.

const response = await ApiService.invoke<{
  invitations: TeamInvitation[];
  count: number;
}>({
  resource: "teams",
  action: "invitations",
  id: "123",
});

Cancel an invitation

Cancels a pending team invitation.

resource

string

required

Must be "teams"

action

string

required

Must be "cancel-invite"

string

required

The invitation UUID.

data

object

required

Show properties

teamId

number

required

The team ID the invitation belongs to.

Response

success

boolean

data

object

Show properties

success

boolean

const response = await ApiService.invoke<{ success: boolean }>({
  resource: "teams",
  action: "cancel-invite",
  id: "invitation-uuid",
  data: {
    teamId: 123,
  },
});

Remove a member

Removes a member from a team.

resource

string

required

Must be "teams"

action

string

required

Must be "remove-member"

string

required

The team ID.

data

object

required

Show properties

memberId

string

required

The user UUID of the member to remove.

Response

success

boolean

data

object

Show properties

success

boolean

const response = await ApiService.invoke<{ success: boolean }>({
  resource: "teams",
  action: "remove-member",
  id: "123",
  data: {
    memberId: "user-uuid",
  },
});

Error responses

Status	Code	Description
400	`VALIDATION_ERROR`	Missing or invalid required parameters
401	`UNAUTHORIZED`	No valid authentication token
403	`FORBIDDEN`	User lacks permission for the operation
404	`NOT_FOUND`	Team or resource not found
500	`INTERNAL_ERROR`	Server error during processing

Overview

Agents

Knowledge

Voice

CRM

Marketplace

Platform

Access control

Team management workflow

Get a team

Response

Create a team

Response (status 201)

Update a team

Response

Delete a team

Response

List team members

Response

Invite a member

Response (status 201)

List pending invitations

Response

Cancel an invitation

Response

Remove a member

Response

Error responses

Overview

Agents

Knowledge

Voice

CRM

Marketplace

Platform

​Access control

​Team management workflow

​Get a team

​Response

​Create a team

​Response (status 201)

​Update a team

​Response

​Delete a team

​Response

​List team members

​Response

​Invite a member

​Response (status 201)

​List pending invitations

​Response

​Cancel an invitation

​Response

​Remove a member

​Response

​Error responses

Access control

Team management workflow

Get a team

Response

Create a team

Response (status 201)

Update a team

Response

Delete a team

Response

List team members

Response

Invite a member

Response (status 201)

List pending invitations

Response

Cancel an invitation

Response

Remove a member

Response

Error responses