Skip to main content

Get Components By Group

The getAvatarComponentsByGroup query is used to retrieve a list of avatar components based on a specific group ID. This query allows users to get all components associated with a particular group.

Query: getAvatarComponentsByGroup​

Schema:​

getAvatarComponentsByGroup(
  groupId: String!
): [AvatarComponent]

Parameters​

  • groupId (String): The name of the required components group. This field is mandatory.

Return​

The query returns a list of AvatarComponent objects that belong to the specified group.

Example Query​

The following is an example of how to use the getAvatarComponentsByGroup query to retrieve avatar components by group:

query {
  getAvatarComponentsByGroup(
    groupId: "engineers"
  ) {
    id,
    name,
    description,
    imageUrl
  }
}

In this example, the query retrieves the avatar components associated with the group ID engineers. The returned AvatarComponent objects include id, name, description, and imageUrl of the components.