Skip to main content
GET
Get Team Meta

Get Team Meta

Returns a minimal metadata object for a team identified by its GUID. Used during checkout flows to resolve team details without loading the full profile — for example, to display the team name and validate member limits when signing up for a tariff.

Authentication

Requires a valid customer bearer token.

Path Parameters

string
required
The team’s UUID (UniqueId). Returned as UniqueId from GET /api/public/teams/my.

Query Parameters

string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

Returns a flat object with core team metadata.
number
required
Numeric identifier for the team.
string
required
Display name of the team.
number
Maximum allowed members. 0 or absent means unlimited.
object | undefined
The team’s default membership plan, if one is assigned.
number
Numeric identifier of the default plan.
string
UUID of the default plan.
string
Display name of the default plan.

Examples

Fetch team meta by GUID

TypeScript Integration

Usage in Portal

Error Responses

error
The customer is not authenticated or the session has expired.
error
No team exists with the specified GUID.