Retrieve a group
GET/clubs/{connection_id}/group/{id}
Parameters
fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Group
Returns
| Response 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 |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'GET',
url: 'https://api.unified.to/clubs/5de520f96e439b002043d8dc/group/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know