Get User Groups

GET /user-groups
Bearer auth

This API call is used to retrieve user groups.

This API call can be executed with or without parameters. When called without any parameters, it will return all user groups.

Note: If your system has a large number of user groups, it is recommended to include the page and size parameters in your API call for efficient pagination and retrieval. This allows you to retrieve user groups in smaller, manageable batches.

Query parameters

  • page integer

    The page number is a 1-based index that works in conjunction with the "size" parameter to retrieve results in a paged manner.

  • size integer

    The number of records to return for a page.

  • include string

    Include additional information for the user group.

    Value is users.

  • userGroupType string

    Filter result for specified user group type.

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

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.

GET /user-groups 
curl \
 --request GET 'https://localhost:8080/user-groups' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 1,
    "name": "Reconcilers",
    "locationId": "Americas",
    "description": "Reconcilers",
    "departmentId": "AA",
    "userGroupType": "Reconciler User Group"
  },
  {
    "id": 2,
    "name": "JE Preparers",
    "description": "JE Preparers",
    "userGroupType": "JE Preparer 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"
}