How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Umami Teams API

Team and access management

Umami Teams API is one of 7 APIs that Umami publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 28 JSON Schema definitions.

Tagged areas include Team. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 28 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.umami.is, http://localhost:3000.

6 operations 4 paths 7 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.umami.is/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Umami Teams API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token obtained from POST /api/auth/login or Umami Cloud API key

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Teams 6

Team and access management

GET
/api/teams
Umami List Teams
listTeams 2 params → 200401
POST
/api/teams
Umami Create Team
createTeam body → 201400401
POST
/api/teams/join
Umami Join Team
joinTeam body → 200400401
GET
/api/teams/{teamId}
Umami Get Team
getTeam 1 param → 200401404
DELETE
/api/teams/{teamId}
Umami Delete Team
deleteTeam 1 param → 200401404
GET
/api/teams/{teamId}/websites
Umami Team Websites
listTeamWebsites 4 params → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Website (10 properties), Team (8 properties), TeamMember (6 properties), TeamList (4 properties). Each schema is shown below with its type and property counts.

WebsiteList
object
Paginated list of websites
4 properties
OkResponse
object
Simple success confirmation
1 property
TeamRequest
object
Request body for creating or updating a team
2 properties 1 required
Website
object
Umami website tracking configuration
10 properties
TeamList
object
Paginated list of teams
4 properties
Team
object
Umami team for collaborative website management
8 properties
TeamMember
object
Team membership record
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

umami-teams-api-openapi.yml Raw ↑

Other APIs Umami publishes across the network.

Umami Authentication API
Umami Events API
Umami Sessions API
Umami Users API
Umami Website Statistics API
Umami Websites API
Where this information came from

This is an independent, third-party profile of Umami Teams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.