Get Single User Group

GET /user-groups/{id}
Bearer auth

This API call is used to retrieve a single user group for specified user group id.

Path parameters

  • id integer Required

    User group ID.

Query parameters

  • include string

    Include additional information for the user group.

    Value is users.

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • id integer

      Unique identifier of user group.

    • name string

      Name of user group.

    • description string

      Description of user group.

    • userGroupType string

      Values are Reconciler User Group, Reviewer User Group, JE Preparer User Group, or JE Security User Group.

    • locationId string

      The location code value.

    • departmentId string

      The department code value.

    • defaultUser object

      Default user of user group.

    • users array[string]

      List of usernames in user group.
  • 401 application/json

    Authentication Error. Invalid credentials.

    Hide response attributes Show response attributes object
  • 403

    Authorization Error. Invalid role for request.

  • 404 application/json

    Failed Response

GET /user-groups/{id} 
curl \
 --request GET 'https://localhost:8080/user-groups/1' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": 1,
  "name": "Reconcilers",
  "locationId": "Americas",
  "description": "Reconcilers",
  "departmentId": "AA",
  "userGroupType": "Reconciler User Group"
}
Response examples (401) 
{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}
Response examples (404) 
{
  "error": "User group not found",
  "status": 404
}