Skip to main content
GET
/
api
/
public
/
teams
/
{teamGuidId}
/
meta
{
  "Id": 123,
  "Name": "<string>",
  "MaxTeamMemberCount": 123,
  "Tariff": {},
  "Tariff.Id": 123,
  "Tariff.UniqueId": "<string>",
  "Tariff.Name": "<string>",
  "401 Unauthorized": {},
  "404 Not Found": {}
}

​
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

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

​
Query Parameters

​
_shape
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.
​
Id
number
required
Numeric identifier for the team.
​
Name
string
required
Display name of the team.
​
MaxTeamMemberCount
number
Maximum allowed members. 0 or absent means unlimited.
​
Tariff
object | undefined
The team’s default membership plan, if one is assigned.
​
Tariff.Id
number
Numeric identifier of the default plan.
​
Tariff.UniqueId
string
UUID of the default plan.
​
Tariff.Name
string
Display name of the default plan.

​
Examples

​
Fetch team meta by GUID

GET /api/public/teams/a1b2c3d4-e5f6-7890-abcd-ef1234567890/meta
Authorization: Bearer {token}

{
  "Id": 55,
  "Name": "Tech Innovators",
  "MaxTeamMemberCount": 20,
  "Tariff": {
    "Id": 301,
    "UniqueId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "Name": "Team Professional"
  }
}

​
TypeScript Integration

import { endpoints } from '@/api/endpoints'

const endpoint = endpoints.teams.meta(teamGuidId)
const { data } = await httpClient.get<typeof endpoint.type>(endpoint.url)

​
Usage in Portal

ContextSource file
Tariff signup step (/checkout/...)src/views/checkout/steps/TariffSignupStep.tsx

​
Error Responses

​
401 Unauthorized
error
The customer is not authenticated or the session has expired.
​
404 Not Found
error
No team exists with the specified GUID.
MethodEndpointDescription
GET/api/public/teams/myList the customer’s teams
GET/api/public/teams/{teamId}/profileFull team profile
GET/api/public/teams/{teamId}/kpiTeam KPI metrics