Teams API

Generated from api/openapi.public.yaml, the same spec the API serves. Try these operations in the API console; errors are Problem Details.

List the workspace’s teams

GET /api/v1/workspaces/{workspaceId}/teams

Operation id	listTeams
Authentication	A secret key (sk_live_… or sk_test_…), an SDK session token (sdk_…), or a secret partner key for one of the partner’s stores.
Permission (key scope)	team:view
Plan feature	seats

Parameters

Name	In	Type	Required	Description
workspaceId	path	string	yes	Workspace id (UUID)

Responses

Status	Description	Body
200	OK	application/json: ListTeamsOutputBody
default	Error	application/problem+json: Problem

Example

curl -X GET "https://api.nexafone.so/api/v1/workspaces/{workspaceId}/teams" \
  -H "Authorization: Bearer $NEXAFON_SECRET_KEY"

Get a team

GET /api/v1/workspaces/{workspaceId}/teams/{teamId}

Operation id	getTeam
Authentication	A secret key (sk_live_… or sk_test_…), an SDK session token (sdk_…), or a secret partner key for one of the partner’s stores.
Permission (key scope)	team:view
Plan feature	seats

Parameters

Name	In	Type	Required	Description
workspaceId	path	string	yes	Workspace id (UUID)
teamId	path	string	yes	Team id (UUID)

Responses

Status	Description	Body
200	OK	application/json: TeamDetailBody
404	Not Found	application/problem+json: Problem
422	Unprocessable Entity	application/problem+json: Problem
500	Internal Server Error	application/problem+json: Problem

Example

curl -X GET "https://api.nexafone.so/api/v1/workspaces/{workspaceId}/teams/{teamId}" \
  -H "Authorization: Bearer $NEXAFON_SECRET_KEY"