Skip to main content
Teams (workspaces) are the organizational unit in Topify.ai. All projects and data belong to a team.

Create team

POST /api/v2/create_team

Create a new team.
Request body:
FieldTypeRequiredDescription
user_idstring (UUID)YesYour user ID
Response: The created team object.
Teams are usually created automatically when you first sign in. You only need this endpoint for custom integrations.

Get my team

GET /api/v2/teams/me

Get the team for the authenticated user.
Query parameters:
ParamTypeDescription
user_idstring (UUID)Your user ID
Response: Team details including name, creation date, and plan information.

List members

GET /api/v2/teams/:team_id/members

List all members of a team.
Query parameters:
ParamTypeDescription
user_idstring (UUID)Your user ID (for access verification)
Response: Array of team members with email, name, and join date.

Add member

POST /api/v2/teams/:team_id/members

Invite or add a member to the team.
Request body:
FieldTypeRequiredDescription
user_idstring (UUID)YesYour user ID (requester)
emailstringYesEmail of the person to add
Behavior:
  • If the email has an existing Topify.ai account, they are added immediately.
  • If not, an invitation email is sent with a verification code.
Error codes:
  • 429 — seat limit reached for your plan
  • 409 — email already belongs to another team

Remove member

DELETE /api/v2/teams/:team_id/members/:email

Remove a member from the team.
Query parameters:
ParamTypeDescription
user_idstring (UUID)Your user ID
You can remove yourself or another member. The last remaining member cannot be removed.