GET
/
v1
/
groups
List groups
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:43.373Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "ef985735-4b23-446e-997a-0928b90f9a24",
        "tenantId": "c25232d9-4a19-44b6-9170-6f88477ae400",
        "baseCurrency": "",
        "groupId": "drDwrQ",
        "groupName": "Engineering Team",
        "status": "ACTIVE",
        "createdOn": "2023-01-01T12:00:00Z",
        "updatedOn": "2023-01-15T12:00:00Z",
        "isSynced": false,
        "parentGroups": [
          {
            "id": "52e488e6-5d12-4308-9a25-639775ba960c",
            "groupName": "Engineering Team",
            "tenantGroupTypeId": "ce8b3943-5775-45e0-b34e-1426effdf89a"
          }
        ],
        "childGroups": [
          {
            "id": "eaa87e8c-a448-4171-a7d8-2a97e47fac29",
            "groupName": "Engineering Team",
            "tenantGroupTypeId": "20f6ce59-f654-45d8-9dd8-48dffbf486d9"
          }
        ],
        "tenantGroupTypeId": "0790f21d-853a-4139-bce8-b986216a8163",
        "tenantGroupTypeName": "Department",
        "decisions": 0,
        "delegations": 0
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
number

Page number

Required range: x >= 1
Example:

1

​
limit
number

Number of items per page

Required range: 1 <= x <= 100
Example:

10

​
tenantId
string
required

Tenant ID

Example:

"4ecfe2eb-510e-4b74-903f-612625a20dfb"

​
search
string

Search in group name and group ID

Example:

"Engineering"

​
tenantGroupTypeIds
string

Tenant Group Type IDs (comma-separated)

Example:

"fcd579c3-f7d2-4378-8dd7-41d20727e952"

​
parentGroupId
string

Parent Group ID to filter child groups

Example:

"e918057e-a7a6-4bd9-8e1a-da79005ca0d5"

​
sourceFilter
string

Comma-separated list of source filters

Example:

"SCIM,MANUAL,ALL"

​
select
string

Comma separated specific Group fields needed in response

Example:

""

​
status
string

Comma-separated list of statuses to filter by

Example:

"ACTIVE,INACTIVE"

​
createdDateStart
string

Creation date range - start date

​
createdDateEnd
string

Creation date range - end date

​
updatedDateStart
string

Last updated date range - start date

​
updatedDateEnd
string

Last updated date range - end date

​
sortBy
enum<string>

Criteria for sorting Groups

Available options:
groupId,
groupName,
status,
createdOn,
updatedOn,
isSynced,
tenantGroupType
Example:

"groupName"

​
sortOrder
enum<string>

Order for sorting Groups

Available options:
asc,
desc
Example:

"asc"

Response

200 - application/json

Groups list retrieved successfully

The response is of type object.