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.

Data Model

idstring
Unique identifier for this group
created_atdate
The date that this group was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this group was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The group's name
descriptionstring
The group's description
sport_type enum
Valid values:
"RUNNING"
"CYCLING"
"SWIMMING"
"TRIATHLON"
"WALKING"
The primary sport of the group
group_type enum
Valid values:
"CASUAL_CLUB"
"RACING_TEAM"
"SHOP"
"COMPANY"
"OTHER"
The group type
addressobject
The group's address
member_countnumber
The number of members in the group
following_countnumber
The number of athletes the group follows
post_countnumber
The number of posts in the group
is_privateboolean
Whether the group is private
is_verifiedboolean
Whether the group is verified
is_featuredboolean
Whether the group is featured
is_adminboolean
Whether the authenticated user is an admin of the group
is_ownerboolean
Whether the authenticated user is the owner of the group
membership_status enum
Valid values:
"MEMBER"
"PENDING"
"NONE"
The authenticated user's membership status
urlstring
The group's vanity URL
profile_image_urlstring
URL to the group's profile picture
cover_image_urlstring
URL to the group's cover photo
activity_typesstring array
The activity types the group focuses on
Are we missing anything? Let us know
Was this page helpful?