Skip to main content
GET
/
v1
/
user
List users
curl --request GET \
  --url https://staging.api.us.aptlydone.com/auth/v1/user \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-25T06:16:49.188Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "6a7d8103-8d39-4fb4-a45e-f4607b5b8476",
        "userId": "10001",
        "loginId": "[email protected]",
        "descopeUserId": "vSGCt98kT7cX2Gawb2dWFkpgQ6VZaxrI",
        "activeTenantId": "2f97d5b9-1736-4b04-b2cf-18d7314c2c6d",
        "email": "[email protected]",
        "name": "Donna Hermiston III",
        "isSAML": false,
        "mobilePhone": "272-535-5085",
        "firstName": "Chelsea",
        "lastName": "Witting",
        "profileImageUrl": "https://picsum.photos/seed/ixDck/3063/974",
        "currencyName": "Euro",
        "currencyCode": "EUR",
        "status": "ACTIVE",
        "accountType": "C",
        "autoProvisioned": false,
        "employeeId": "Q",
        "employeeType": "U",
        "dateFormat": "MM/DD/YYYY",
        "userType": "y",
        "searchData": [
          "Usability",
          "Developer"
        ],
        "managerSync": true,
        "manager": {
          "id": "d5dc4dd9-bf15-4992-b6ef-4372a3ff3ed3",
          "userId": "10001",
          "descopeUserId": "HGPusnGo7LY225bob0Tg2sNbVPBFLO8T",
          "name": "Jaime Wiza",
          "email": "[email protected]",
          "firstName": "Elian",
          "lastName": "Reinger",
          "mobilePhone": "859-503-6233 x95670",
          "profileImageUrl": "https://loremflickr.com/429/3636?lock=5343508147167765",
          "createdOn": "2025-06-25T04:31:23.563Z",
          "updatedOn": "2025-06-24T17:20:32.235Z",
          "userPositions": [
            {
              "id": "1b639583-b421-439f-9bbc-e909aa78126e",
              "userId": "86e26861-524b-4d36-94c6-70a70726add9",
              "tenantId": "62c0e2b7-259d-4692-9f3d-3655665366c2",
              "positionsId": "54256ae5-3c62-4447-adf8-3e3cc6612a99",
              "autoProvisioned": false,
              "isEditable": false,
              "isDeleted": true,
              "deletedOn": "2024-10-28T09:18:34.656Z",
              "createdOn": "2025-06-24T15:29:46.577Z",
              "updatedOn": "2025-06-24T20:18:43.389Z",
              "positionName": "Senior Developer",
              "isSCIMProvisioned": false
            }
          ],
          "primaryOrganization": {
            "groupName": "Aplty Inc.",
            "tenantGroupTypeId": "b135555e-0520-482b-bfbf-8429c293c268",
            "tenantGroupTypeName": "Organization"
          },
          "managerName": "Fannie Lueilwitz",
          "managerProfileImageUrl": "https://loremflickr.com/1810/1701?lock=3094412370077509"
        },
        "isDeleted": false,
        "isExpirePassword": false,
        "createdOn": "2025-06-25T01:27:29.403Z",
        "lastLoginDate": "2025-06-24T15:29:15.070Z",
        "createdBy": "5ec51c50-09c5-4bd3-9a4e-240903b20e68",
        "updatedOn": "2025-06-24T07:10:37.466Z",
        "updatedBy": "2480599d-bd76-4c73-a107-e6513bf8b54f",
        "deletedOn": "2024-10-01T20:34:39.873Z",
        "delegationsReceived": 1,
        "delegationsIssued": 1,
        "dashboardData": [
          {
            "x": 0,
            "y": 0,
            "w": 2,
            "h": 1,
            "i": "0"
          },
          {
            "x": 0,
            "y": 1,
            "w": 2,
            "h": 4,
            "i": "1"
          },
          {
            "x": 0,
            "y": 5,
            "w": 1,
            "h": 4,
            "i": "2"
          },
          {
            "x": 1,
            "y": 5,
            "w": 1,
            "h": 4,
            "i": "3"
          }
        ],
        "userRoles": [
          {
            "id": "340314db-0571-4a85-9296-8ccea2d5ff90",
            "tenantId": "a2f84c63-2056-46c8-a975-5fc22efa5060",
            "tenantRoleId": "a1729a44-15d6-4976-b3a5-c4dceff45835",
            "roleName": "heartache harmful",
            "autoProvisioned": true,
            "createdOn": "2025-06-25T04:31:42.785Z",
            "deletedOn": "2025-05-05T01:45:20.777Z",
            "updatedOn": "2025-06-25T02:53:18.799Z"
          }
        ],
        "userPositions": [
          {
            "id": "1b639583-b421-439f-9bbc-e909aa78126e",
            "userId": "86e26861-524b-4d36-94c6-70a70726add9",
            "tenantId": "62c0e2b7-259d-4692-9f3d-3655665366c2",
            "positionsId": "54256ae5-3c62-4447-adf8-3e3cc6612a99",
            "autoProvisioned": false,
            "isEditable": false,
            "isDeleted": true,
            "deletedOn": "2024-10-28T09:18:34.656Z",
            "createdOn": "2025-06-24T15:29:46.577Z",
            "updatedOn": "2025-06-24T20:18:43.389Z",
            "positionName": "Senior Developer",
            "isSCIMProvisioned": false
          }
        ],
        "userGroups": [
          {
            "id": "0babd381-2af5-4bf7-ac1c-0230f25cf088",
            "tenantId": "1eb866a0-2a81-4d3f-9831-6b4e9f4e633d",
            "userId": "0e1b099f-2e52-4307-8860-89314ef97dbb",
            "groupId": "3cad0e27-f8f0-4a96-9bbb-1fae4f9fb04f",
            "groupTypeId": "9a366bfc-7810-4d0f-a482-ed0cd09c6c15",
            "groupName": "Engineering Team",
            "groupTypeName": "Department",
            "isPrimaryOrg": false,
            "primaryOrgSetOn": "2025-06-24T11:18:20.853Z",
            "autoProvisioned": true,
            "isDeleted": true,
            "deletedOn": "2025-05-17T06:57:51.956Z",
            "createdOn": "2025-06-24T10:25:28.539Z",
            "updatedOn": "2025-06-24T21:38:00.944Z"
          }
        ],
        "isImpersonated": true
      }
    ]
  }
}

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<uuid>
required

Tenant ID

Example:

"db28340c-dd5a-4ae0-a280-7643351b87da"

​
search
string

Search term

​
status
string

Comma-separated list of user statuses to filter by

Example:

"ACTIVE,INACTIVE,INVITED"

​
sourceType
string

Comma-separated list of source types to filter by (e.g., "Directory Sync", "Manually Added")

Example:

"Directory Sync,Manually Added"

​
employeeType
string

Employee type filter

​
roleIds
string

Filter by role IDs (comma-separated UUIDs)

Example:

"541ac968-b872-4485-8853-4f1d64929442,083f40a3-b69e-47a0-a73e-e79bb8e7250d"

​
groupIds
string

Filter by group IDs (comma-separated UUIDs)

Example:

"63387a65-d762-4b94-8c21-450263fb3014,4a79d776-ef21-4532-87e4-5955c43e9e8e"

​
positionIds
string

Filter by position IDs (comma-separated UUIDs)

Example:

"8d432a2d-21af-4014-ae7e-fbfcfa346ddc,844e9f04-9f3b-4dea-ae14-2e8096f7768a"

​
managerIds
string

Filter by manager IDs (comma-separated UUIDs)

Example:

"fab72142-fb37-4ce4-b179-f9c04fb964f8,5a8223e4-e243-4cf9-a24c-cb6fb36c7bbc"

​
primaryOrgIds
string

Filter by primary organization IDs (comma-separated UUIDs)

Example:

"d0c5d218-e8a0-437b-a37b-890f68c2a1c9,d2874990-b310-46e1-a7ab-bb1dda74b281"

​
createdDateStart
string<date-time>

Creation date range - start date

​
createdDateEnd
string<date-time>

Creation date range - end date

​
updatedDateStart
string<date-time>

Last updated date range - start date

​
updatedDateEnd
string<date-time>

Last updated date range - end date

​
lastLoginDateStart
string<date-time>

Last login date range - start date

​
lastLoginDateEnd
string<date-time>

Last login date range - end date

​
sortBy
string

Field to sort by

​
sortOrder
enum<string>

Sort order

Available options:
asc,
desc

Response

200 - application/json

Users fetched successfully

​
statusCode
number
required
Example:

200

​
timestamp
string
required
Example:

"2025-06-25T06:16:49.188Z"

​
message
string
required
Example:

"Success"

​
data
object