Group data model
SummaryClub / DetailedClub, but generic across providers (TeamSnap team, PlayHQ org, etc.).
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this group |
created_at | string (date-time) | No | The date that this group was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this group was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The group's name |
description | string | No | The group's description |
sport_type | enum | No | The primary sport of the group Values: RUNNING, CYCLING, SWIMMING, TRIATHLON, WALKING, HIKING, OTHER |
group_type | enum | No | The group type Values: CASUAL_CLUB, RACING_TEAM, SHOP, COMPANY, OTHER |
address | object | No | The group's address |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | |
address.region_code | string | No | |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | ISO 2-digit country code |
member_count | number | No | The number of members in the group |
following_count | number | No | The number of athletes the group follows |
post_count | number | No | The number of posts in the group |
is_private | boolean | No | Whether the group is private |
is_verified | boolean | No | Whether the group is verified |
is_featured | boolean | No | Whether the group is featured |
is_admin | boolean | No | Whether the authenticated user is an admin of the group |
is_owner | boolean | No | Whether the authenticated user is the owner of the group |
membership_status | enum | No | The authenticated user's membership status Values: MEMBER, PENDING, NONE |
url | string | No | The group's vanity URL |
profile_image_url | string | No | URL to the group's profile picture |
cover_image_url | string | No | URL to the group's cover photo |
activity_types | string[] | No | The activity types the group focuses on |
Are we missing anything? Let us know