clubs
group

Retrieve a group

get/clubs/{connection_id}/group/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/clubs/{connection_id}/group/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Group

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this group

created_atstring date-time

The date that this group was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

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'RUNNING' | 'CYCLING' | 'SWIMMING' | 'TRIATHLON' | 'WALKING' | 'HIKING' | 'OTHER'

The primary sport of the group

group_type'CASUAL_CLUB' | 'RACING_TEAM' | 'SHOP' | 'COMPANY' | 'OTHER'

The group type

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'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[]

The activity types the group focuses on

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.