Skip to main content
GET
/
v1
/
group-types
List group types
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/group-types \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:43.383Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "8fbc5342-8e74-46ff-afa0-f78390dc216c",
        "tenantId": "437218eb-07f2-457a-8628-de3936de2f68",
        "groupTypeName": "Department",
        "shouldAllowEnableDisable": true,
        "isDefault": false,
        "disableOption": "NA",
        "isDeleted": false,
        "status": "ACTIVE",
        "createdBy": null,
        "createdOn": "2024-12-18T09:50:43.338Z",
        "updatedOn": "2024-12-18T09:50:43.338Z",
        "updatedBy": null
      }
    ]
  }
}

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:

"63b38aca-5c5f-4da8-8d43-2b66d1ae68e8"

​
isActive
boolean

Is Active

Example:

false

Response

200 - application/json

Tenant group types fetched successfully

​
statusCode
number
required
Example:

200

​
timestamp
string
required
Example:

"2025-06-24T08:51:43.383Z"

​
message
string
required
Example:

"Success"

​
data
object