clubs
group

List all groups

Changed on

Returns a list of ClubsGroups. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/clubs/{connection_id}/group

Request

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

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

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

rawobject

The raw data returned by the integration for this group

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status