users

Get user groups

get/v0/user_groups

Request

  • Base URL: https://www.worldcubeassociation.org/api
  • URL: https://www.worldcubeassociation.org/api/v0/user_groups
  • Auth: HTTP bearer

Query parameters

isActiveboolean

Filter by whether the group is active

isHiddenboolean

Filter by whether the group is hidden

groupTypestring

Filter by group type (e.g., "officers")

sortstring

Sort by a specific field (e.g., "start_date", "-created_at")

Response

A list of user groups

idinteger required
namestring required
group_typestring required
parent_group_idinteger nullable
is_activeboolean required
is_hiddenboolean required
metadata_idinteger nullable
metadata_typestring nullable
created_atstring date-time required
updated_atstring date-time required

Example response

[
  {
    "lead_user": {
      "id": 267,
      "name": "Tim Reynolds",
      "gender": "m",
      "wca_id": "2005REYN01",
      "country_iso2": "US",
      "delegate_status": "delegate",
      "teams": [
        {
          "friendly_id": "wst",
          "avatar": {
            "url": "https://avatars.worldcubeassociation.org/uploads/user/avatar/2099EXAM/1535183030.jpg",
            "thumb_url": "https://avatars.worldcubeassociation.org/uploads/user/avatar/2099EXAM/1535183030_thumb.jpg"
          }
        }
      ],
      "url": "https://www.worldcubeassociation.org/persons/2005REYN01",
      "avatar": {
        "url": "https://avatars.worldcubeassociation.org/uploads/user/avatar/2099EXAM/1535183030.jpg",
        "thumb_url": "https://avatars.worldcubeassociation.org/uploads/user/avatar/2099EXAM/1535183030_thumb.jpg"
      }
    }
  }
]

Changes

No recorded changes to this operation across all 3 revisions of this API.