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": "2026-01-12T09:10:13.120Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "d4b8eae5-02dc-4a9a-9afe-b2f72e006ebb",
        "userId": "10001",
        "loginId": "Delpha82@yahoo.com",
        "descopeUserId": "7eOCsfn938mPjGwc5IZu4m5QAQWZS0xy",
        "activeTenantId": "3d4c3b64-f52d-4890-aa26-ea2e52eb5a4d",
        "email": "Clay.Purdy@gmail.com",
        "name": "Vera Wolf",
        "displayName": "Brooke Rohan",
        "isSAML": false,
        "mobilePhone": "1-491-503-1712 x7659",
        "firstName": "Jolie",
        "lastName": "Morissette-Spencer",
        "profileImageUrl": "https://loremflickr.com/807/3278?lock=727001695474930",
        "currencyName": "Euro",
        "currencyCode": "EUR",
        "accountType": "h",
        "autoProvisioned": false,
        "employeeId": "f",
        "employeeNumber": "h",
        "employeeType": "D",
        "employmentType": "j",
        "userType": "z",
        "sourceId": "LaTdLstQ4lRlowebEqMq",
        "actorType": "khOhlolFNb",
        "aiAgentType": "XwUPLzjRvaLBsCG",
        "startDate": "2025-11-19T05:27:09.941Z",
        "terminationDate": "2026-10-16T18:32:34.796Z",
        "customAttributes": {
          "department": "Engineering",
          "level": "Senior"
        },
        "externalId": "EXT12345",
        "instanceId": "6a5dd288-ec68-44ff-a1ce-b0128347b3b6",
        "systemIntegrationId": "6e94c7f7-576d-48ed-8cc0-b8b09f56cba8",
        "displayLanguage": "en-US",
        "columnViewSettings": {
          "columns": [
            "name",
            "email",
            "status"
          ]
        },
        "searchData": [
          "Directives",
          "Liaison"
        ],
        "managerSync": true,
        "manager": {
          "id": "f99a50c1-f10a-47ee-a20d-8792e1a41be8",
          "userId": "10001",
          "descopeUserId": "NAe2gVjONZqYRgtvliF3pyKmPchGcHXg",
          "name": "Mr. Ivan Thiel",
          "email": "Lonnie2@yahoo.com",
          "firstName": "Adan",
          "lastName": "Johnston",
          "displayName": "Lucia Mayert",
          "mobilePhone": "(270) 663-0245 x3376",
          "profileImageUrl": "https://picsum.photos/seed/46GUUknbGJ/2329/2262",
          "createdOn": "2026-01-12T05:07:05.101Z",
          "updatedOn": "2026-01-12T03:30:03.871Z",
          "userPositions": [
            {
              "id": "64648e27-e093-44c3-b5a1-49154a0a1660",
              "userId": "898bf847-18c5-4022-b4be-6035aa06877f",
              "tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
              "positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
              "autoProvisioned": true,
              "instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
              "isEditable": false,
              "isDeleted": true,
              "deletedOn": "2025-08-19T23:46:35.207Z",
              "createdOn": "2026-01-11T12:03:07.517Z",
              "updatedOn": "2026-01-11T19:28:18.878Z",
              "positionName": "Senior Developer",
              "isSCIMProvisioned": false,
              "externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
            }
          ],
          "primaryOrganization": {
            "groupName": "Aplty Inc.",
            "displayName": "Aplty Incorporated",
            "tenantGroupTypeId": "03cf8779-7be8-4ea9-a02e-99aa4454e94a",
            "tenantGroupTypeName": "Organization"
          },
          "managerName": "Doris Brakus",
          "managerProfileImageUrl": "https://loremflickr.com/567/2473?lock=5385426157985712"
        },
        "isDeleted": true,
        "isExpirePassword": true,
        "createdOn": "2026-01-12T04:59:38.064Z",
        "lastLoginDate": "2026-01-11T09:45:20.832Z",
        "createdBy": "56dbdb67-fdb4-478c-bb02-cea7b3e899ec",
        "updatedOn": "2026-01-11T11:57:54.376Z",
        "updatedBy": "f6267b64-ddad-4db5-ab64-b587d49af1b6",
        "deletedOn": "2025-01-27T10:51:41.196Z",
        "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": "320bf21d-7b31-4b31-93ef-1a2e9f93f8a9",
            "tenantId": "8fcca66f-5b95-4f54-a8fd-b1c27dd092ef",
            "tenantRoleId": "9c9bd186-23f1-4f5f-877f-b25aad685652",
            "roleName": "pine begonia",
            "autoProvisioned": false,
            "instanceId": "5863ab84-7099-4ac2-8b48-f24f1b21b4a3",
            "createdOn": "2026-01-11T22:33:40.204Z",
            "deletedOn": "2025-05-31T10:27:33.998Z",
            "updatedOn": "2026-01-12T03:25:36.185Z"
          }
        ],
        "userPositions": [
          {
            "id": "64648e27-e093-44c3-b5a1-49154a0a1660",
            "userId": "898bf847-18c5-4022-b4be-6035aa06877f",
            "tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
            "positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
            "autoProvisioned": true,
            "instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
            "isEditable": false,
            "isDeleted": true,
            "deletedOn": "2025-08-19T23:46:35.207Z",
            "createdOn": "2026-01-11T12:03:07.517Z",
            "updatedOn": "2026-01-11T19:28:18.878Z",
            "positionName": "Senior Developer",
            "isSCIMProvisioned": false,
            "externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
          }
        ],
        "userGroups": [
          {
            "id": "77827dfa-cf21-4fec-a5bd-c568d9583431",
            "tenantId": "277ab493-cb1d-40f3-8d61-6432cc78df9a",
            "userId": "0e2a3c9d-3210-4e98-9dcc-67e8f63305c1",
            "groupId": "2b0e14b4-2d70-4517-afc3-9ba10bb890c2",
            "groupTypeId": "40471fbe-5866-486d-9f76-c96482e42277",
            "groupName": "Engineering Team",
            "groupTypeName": "Department",
            "displayName": "Engineering Department",
            "isPrimaryOrg": false,
            "externalId": "0802fdf7-09f2-4445-9e7c-3fc145cbf544",
            "instanceId": "c024da14-f39b-4aa5-9be8-6003132f6c71",
            "primaryOrgSetOn": "2026-01-11T23:45:02.944Z",
            "autoProvisioned": true,
            "isDeleted": true,
            "deletedOn": "2025-06-16T09:06:25.957Z",
            "createdOn": "2026-01-11T10:22:54.670Z",
            "updatedOn": "2026-01-11T18:31:52.005Z"
          }
        ],
        "status": "ACTIVE",
        "dateFormat": "MM/DD/YYYY",
        "isImpersonated": true
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.aptlydone.com/llms.txt

Use this file to discover all available pages before exploring further.

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:

"b360ec79-ee0e-45a1-a6cc-279f5a10ab68"

ā€‹
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:

"f8e2d583-819a-463c-b815-af1c927b4017,6f5fbaec-a2a6-422b-93f3-b5d5532cdb88"

ā€‹
groupIds
string

Filter by group IDs (comma-separated UUIDs)

Example:

"2b63dc7d-4d1f-4f04-9611-23edb3e7ebfd,06c279f8-e3f6-4496-874a-f7f5aebad2c2"

ā€‹
positionIds
string

Filter by position IDs (comma-separated UUIDs)

Example:

"ce066ed3-1f02-4c6b-a1c4-d06986567e78,8674cce9-8fbf-409f-90fb-2e203803c35e"

ā€‹
managerIds
string

Filter by manager IDs (comma-separated UUIDs)

Example:

"379bb5dd-99f8-4afc-97f0-54368bc6f91c,7f1954e9-ee53-4ebf-be1e-00f2cd4520be"

ā€‹
primaryOrgIds
string

Filter by primary organization IDs (comma-separated UUIDs)

Example:

"8e6f65f2-bb0a-4762-bf1e-845f05cfc237,62cdb51a-b375-4ec8-ae8a-793c96316900"

ā€‹
externalId
string

Filter by external ID

Example:

"EXT123456"

ā€‹
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:

"2026-01-12T09:10:13.120Z"

ā€‹
message
string
required
Example:

"Success"

ā€‹
data
object