v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get group by ID

get/api_gateway/v1/badges/group/{groupId}

Path parameters

groupIdstring required

Unique ID of the group.

Query parameters

order'ASC' | 'DESC'

Sort response based on order.

sizeinteger

The number of items or records returned in a single API response

pagestring

The amount of the data that you want to retrieve. Default value: 10.

statusboolean

Indicates whether the group is active. Ex: True

Response

200

{"stackTrail":"paths:/api_gateway/v1/badges/group/{groupId}:get:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api_gateway/v1/badges/group/{groupId}:get:responses:200:content:application/json:schema:properties:warnings","oasType":"schema","type":"unknown"}

Example response

{
  "data": {
    "id": "6560ad9c7e3e81134376008b",
    "orgId": 4000106,
    "name": "cafeb9fe",
    "rank": 1,
    "createdBy": 50677380,
    "createdOn": 1700834716.366,
    "lastUpdatedBy": 50677380,
    "lastUpdatedOn": 1700834716.366,
    "isActive": true
  }
}