Members

Download schema

Endpoints for viewing and managing team members.

List team members

GET

https://account.chief.app/api

/v1/teams/{teamSlug}/members

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all users who are members of a team.

List team members › path Parameters

teamSlug

string · required

team slug

List team members › query Parameters

page

integer · min: 1

Page number to return.

Default: 1

per_page

integer · min: 1 · max: 100

Number of items to return per page.

Default: 50

List team members › Responses

Paginated set of TeamMember

TeamMember[] · required

object · required

Show team member

GET

https://account.chief.app/api

/v1/teams/{teamSlug}/members/{userId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Retrieve a single user who is a member of a team.

Show team member › path Parameters

teamSlug

string · required

team slug

userId

string · required

user identifier

Show team member › Responses

TeamMember

TeamMember · required

Remove team member

DELETE

https://account.chief.app/api

/v1/teams/{teamSlug}/members/{userId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Remove a user from a team. A team's final owner cannot be removed.

Remove team member › path Parameters

teamSlug

string · required

team slug

userId

string · required

user identifier

Remove team member › Responses

No content

No data returned

Update team member role

PATCH

https://account.chief.app/api

/v1/teams/{teamSlug}/members/{userId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Change a team member's role.

Update team member role › path Parameters

teamSlug

string · required

team slug

userId

string · required

user identifier

Update team member role › Request Body

TeamUpdateMemberRoleRequest

role

string · enum

New membership role.

Enum values:

owner

member

billing

accessible_app_ids

array | null · unique

Application IDs this member can access. Null grants all team applications.

Enum values:

domainchief

certchief

deploychief

tny

flowguard

backupchief

socketchief

billdo

Update team member role › Responses

No content

No data returned

Invite team member

POST

https://account.chief.app/api

/v1/teams/{teamSlug}/invitations

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Send an expiring team invitation to an email address.

Invite team member › path Parameters

teamSlug

string · required

team slug

Invite team member › Request Body

TeamInviteMemberRequest

email

string · email · required

Email address to invite to the team.

role

string | null · enum

Role assigned after acceptance.

Enum values:

owner

member

billing

accessible_app_ids

array | null · unique

Application IDs this member can access. Null grants all team applications.

Enum values:

domainchief

certchief

deploychief

tny

flowguard

backupchief

socketchief

billdo

Invite team member › Responses

No data returned

Invoices Team access tokens

List team members

GET

https://account.chief.app/api

/v1/teams/{teamSlug}/members

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all users who are members of a team.

List team members › path Parameters

teamSlug

string · required

team slug

List team members › query Parameters

page

integer · min: 1

Page number to return.

Default: 1

per_page

integer · min: 1 · max: 100

Number of items to return per page.

Default: 50

List team members › Responses

Paginated set of TeamMember

TeamMember[] · required

object · required

Show team member

GET

https://account.chief.app/api

/v1/teams/{teamSlug}/members/{userId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Retrieve a single user who is a member of a team.

Show team member › path Parameters

teamSlug

string · required

team slug

userId

string · required

user identifier

Show team member › Responses

TeamMember

TeamMember · required

Remove team member

DELETE

https://account.chief.app/api

/v1/teams/{teamSlug}/members/{userId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Remove a user from a team. A team's final owner cannot be removed.

Remove team member › path Parameters

teamSlug

string · required

team slug

userId

string · required

user identifier

Remove team member › Responses

No content

No data returned

Update team member role

PATCH

https://account.chief.app/api

/v1/teams/{teamSlug}/members/{userId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Change a team member's role.

Update team member role › path Parameters

teamSlug

string · required

team slug

userId

string · required

user identifier

Update team member role › Request Body

TeamUpdateMemberRoleRequest

role

string · enum

New membership role.

Enum values:

owner

member

billing

accessible_app_ids

array | null · unique

Application IDs this member can access. Null grants all team applications.

Enum values:

domainchief

certchief

deploychief

tny

flowguard

backupchief

socketchief

billdo

Update team member role › Responses

No content

No data returned

Invite team member

POST

https://account.chief.app/api

/v1/teams/{teamSlug}/invitations

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Send an expiring team invitation to an email address.

Invite team member › path Parameters

teamSlug

string · required

team slug

Invite team member › Request Body

TeamInviteMemberRequest

email

string · email · required

Email address to invite to the team.

role

string | null · enum

Role assigned after acceptance.

Enum values:

owner

member

billing

accessible_app_ids

array | null · unique

Application IDs this member can access. Null grants all team applications.

Enum values:

domainchief

certchief

deploychief

tny

flowguard

backupchief

socketchief

billdo

Invite team member › Responses

No data returned