KeyEnvKeyEnv
API Reference

Teams

Team management and collaboration

Teams

Team management and collaboration

List teams

GET /api/v1/teams

Returns all teams the current user is a member of

Operation ID: listTeams · Authentication: Authorization: Bearer <token>

Responses

StatusDescriptionBody
200List of teamsobject
401Authentication requiredError

Response body (200)

FieldTypeDescription
teamsobject[]

Example

curl -X GET "https://api.keyenv.dev/api/v1/teams" \
  -H "Authorization: Bearer $KEYENV_TOKEN"

Create team

POST /api/v1/teams

Creates a new team with the current user as owner

Operation ID: createTeam · Authentication: Authorization: Bearer <token>

Request body

application/json (required)

FieldTypeRequiredDescription
namestringyes

Responses

StatusDescriptionBody
201Team createdTeam
400Invalid requestError
401Authentication requiredError

Response body (201)

FieldTypeDescription
idstring (uuid)
namestring
slugstring
planenum (free, team, enterprise)
is_personalboolean
created_atstring (date-time)

Example

curl -X POST "https://api.keyenv.dev/api/v1/teams" \
  -H "Authorization: Bearer $KEYENV_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Get team

GET /api/v1/teams/{teamId}

Returns team details including members

Operation ID: getTeam · Authentication: Authorization: Bearer <token>

Path parameters

NameTypeRequiredDescription
teamIdstring (uuid)yesTeam UUID

Responses

StatusDescriptionBody
200Team detailsobject
401Authentication requiredError
403Insufficient permissionsError
404Resource not foundError

Example

curl -X GET "https://api.keyenv.dev/api/v1/teams/{teamId}" \
  -H "Authorization: Bearer $KEYENV_TOKEN"

Invite team member

POST /api/v1/teams/{teamId}/members

Invites a user to join the team by email

Operation ID: inviteTeamMember · Authentication: Authorization: Bearer <token>

Path parameters

NameTypeRequiredDescription
teamIdstring (uuid)yesTeam UUID

Request body

application/json (required)

FieldTypeRequiredDescription
emailstring (email)yes
roleenum (admin, developer, viewer)yes

Responses

StatusDescriptionBody
201Member invitedTeamMember
400Invalid requestError
401Authentication requiredError
403Insufficient permissionsError

Response body (201)

FieldTypeDescription
user_idstring (uuid)
emailstring (email)
namestring
avatar_urlstring (uri)
roleenum (owner, admin, developer, viewer)
joined_atstring (date-time)

Example

curl -X POST "https://api.keyenv.dev/api/v1/teams/{teamId}/members" \
  -H "Authorization: Bearer $KEYENV_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","role":"admin"}'

Update member role

PATCH /api/v1/teams/{teamId}/members/{userId}

Updates a team member's role

Operation ID: updateMemberRole · Authentication: Authorization: Bearer <token>

Path parameters

NameTypeRequiredDescription
teamIdstring (uuid)yesTeam UUID
userIdstring (uuid)yesUser UUID

Request body

application/json (required)

FieldTypeRequiredDescription
roleenum (admin, developer, viewer)yes

Responses

StatusDescriptionBody
200Role updatedTeamMember
400Invalid requestError
401Authentication requiredError
403Insufficient permissionsError

Response body (200)

FieldTypeDescription
user_idstring (uuid)
emailstring (email)
namestring
avatar_urlstring (uri)
roleenum (owner, admin, developer, viewer)
joined_atstring (date-time)

Example

curl -X PATCH "https://api.keyenv.dev/api/v1/teams/{teamId}/members/{userId}" \
  -H "Authorization: Bearer $KEYENV_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role":"admin"}'

Remove team member

DELETE /api/v1/teams/{teamId}/members/{userId}

Removes a member from the team

Operation ID: removeTeamMember · Authentication: Authorization: Bearer <token>

Path parameters

NameTypeRequiredDescription
teamIdstring (uuid)yesTeam UUID
userIdstring (uuid)yesUser UUID

Responses

StatusDescriptionBody
204Member removed
401Authentication requiredError
403Insufficient permissionsError
404Resource not foundError

Example

curl -X DELETE "https://api.keyenv.dev/api/v1/teams/{teamId}/members/{userId}" \
  -H "Authorization: Bearer $KEYENV_TOKEN"

On this page