users

Get user roles

get/v0/user_roles

Request

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

Query parameters

isActiveboolean

Filter by whether the group is active

isGroupHiddenboolean

Filter by whether the group is hidden

userIdinteger

Filter by user ID

groupIdinteger

Filter by group ID

statusstring

Filter by metadata status (e.g., "chair")

groupTypestring

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

parentGroupIdnumber

Filter by parent Group

isLeadboolean

Filter by whether the user is the lead of the group

sortstring

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

perPageinteger

Number of results per page

Response

A list of user roles

idinteger required

start_datestring date required

end_datestring date nullable required

classstring

Example response

[
  {
    "group": {
      "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"
        }
      }
    },
    "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.