Costfluent Public API
​integer · int32 · required​integer · int32 · required
​TeamPublicId · pattern: ​string · required​boolean​integer · int32​string · date-time
​TeamPublicId · pattern: ​TeamPublicId · pattern: ​string · required​boolean​string · date-time
​TeamPublicId · pattern: ​TeamPublicId · pattern: ​string · required​boolean​integer · int32​string · date-time
​TeamPublicId · pattern:
​TeamPublicId · pattern: ​UserPublicId · pattern: ​TeamRole · enum · required
​TeamPublicId · pattern: ​UserPublicId · pattern: ​TeamRole · enum · required
​TeamPublicId · pattern: ​UserPublicId · pattern:
​TeamPublicId · pattern: ​integer · int32 · required​integer · int32 · required
​TeamPublicId · pattern: ​WorkspacePublicId · pattern: ​WorkspaceAccessLevel · enum · required
​TeamPublicId · pattern: ​WorkspacePublicId · pattern:
List teams
GET
https://api.costfluent.com
/v1/teams
Bearer (API token)
Returns the organization's teams, the Everyone team included. Needs an organization token.
query Parameters
pagelimitList teams › Responses
Success
​PaginationLinks · required
​TeamResponse[] · required
Create team
POST
https://api.costfluent.com
/v1/teams
Bearer (API token)
Creates a team with no members and no workspace access. Team names are unique in the organization.
Create team › Responses
Created
id^team_[A-Za-z0-9_-]{… · requirednameisSystemTeammemberCountcreatedAtGet team
GET
https://api.costfluent.com
/v1/teams/{teamId}
Bearer (API token)
Returns a team with its members and its workspace access
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredGet team › Responses
Success
id^team_[A-Za-z0-9_-]{… · requiredname​TeamMemberResponse[] · required
​TeamWorkspaceAccessResponse[] · required
isSystemTeamcreatedAtUpdate team
PUT
https://api.costfluent.com
/v1/teams/{teamId}
Bearer (API token)
Renames a team. The Everyone team cannot be renamed.
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredUpdate team › Responses
Success
id^team_[A-Za-z0-9_-]{… · requirednameisSystemTeammemberCountcreatedAtDelete team
DELETE
https://api.costfluent.com
/v1/teams/{teamId}
Bearer (API token)
Deletes a team, its memberships and its workspace access. The Everyone team cannot be deleted.
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredDelete team › Responses
No Content
No data returned
Add team member
POST
https://api.costfluent.com
/v1/teams/{teamId}/members
Bearer (API token)
Adds a member of the organization to a team with a role. A user already in the team is a conflict.
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredAdd team member › Request Body
userId^usr_[A-Za-z0-9_-]{2… · requiredroleEnum values:
viewer
editor
owner
Add team member › Responses
No Content
No data returned
Update team member
PUT
https://api.costfluent.com
/v1/teams/{teamId}/members/{userId}
Bearer (API token)
Changes a team member's role
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requireduserId^usr_[A-Za-z0-9_-]{2… · requiredUpdate team member › Request Body
roleEnum values:
viewer
editor
owner
Update team member › Responses
No Content
No data returned
Remove team member
DELETE
https://api.costfluent.com
/v1/teams/{teamId}/members/{userId}
Bearer (API token)
Removes a member from a team. Nobody can be removed from the Everyone team.
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requireduserId^usr_[A-Za-z0-9_-]{2… · requiredRemove team member › Responses
No Content
No data returned
List team workspace access
GET
https://api.costfluent.com
/v1/teams/{teamId}/workspaces
Bearer (API token)
Returns the workspaces a team has an access level on
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredquery Parameters
pagelimitList team workspace access › Responses
Success
​PaginationLinks · required
​TeamWorkspaceAccessResponse[] · required
Set team workspace access
PUT
https://api.costfluent.com
/v1/teams/{teamId}/workspaces/{workspaceId}
Bearer (API token)
Sets the access level a team's members have on a workspace, replacing any level it had
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredworkspaceId^wsp_[A-Za-z0-9_-]{2… · requiredSet team workspace access › Request Body
accessLevelEnum values:
noAccess
canView
canEdit
Set team workspace access › Responses
No Content
No data returned
Remove team workspace access
DELETE
https://api.costfluent.com
/v1/teams/{teamId}/workspaces/{workspaceId}
Bearer (API token)
Removes a team's access level on a workspace
path Parameters
teamId^team_[A-Za-z0-9_-]{… · requiredworkspaceId^wsp_[A-Za-z0-9_-]{2… · requiredRemove team workspace access › Responses
No Content
No data returned