Skip to main content
GET
/
v1
/
user
/
personnel
/
users
Get users with positions
curl --request GET \
  --url https://staging.api.us.aptlydone.com/auth/v1/user/personnel/users \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:10:13.123Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "userId": "db052330-760d-49da-9df2-485ded4bc5b5",
        "name": "Carrie Carter",
        "displayName": "Wilbur Kreiger",
        "positions": "Customer Group Developer, International Implementation Agent"
      }
    ]
  }
}

Authorizations

ā€‹
Authorization
string
header
required

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

Query Parameters

ā€‹
page
number
default:1
required

Page number

ā€‹
limit
number
default:10
required

Number of items per page

ā€‹
tenantId
string
required

Tenant ID

Example:

"e881a66d-6d5f-43df-86c9-bf7b84f6f1d8"

ā€‹
search
string

Search term to filter users or positions by name

Example:

"John Doe"

ā€‹
groupIds
string

Group IDs (comma separated)

Example:

"bbcb4ca6-3eb7-42a5-84dc-5c8e5605a8ed, 9315726c-47ef-472f-b070-bd6f1993c68b"

ā€‹
userIds
string

User IDs (comma separated)

Example:

"5bdbea24-3cb8-4033-8f55-4ee9e629b656, 6acabc85-a040-4ea4-b8e5-1825a6135f16"

ā€‹
sortBy
enum<string>

Field to sort by

Available options:
positions,
users
Example:

"users"

ā€‹
sortOrder
enum<string>
default:asc

Sort order

Available options:
asc,
desc

Response

200 - application/json

User personnel data retrieved successfully

ā€‹
statusCode
number
required
Example:

200

ā€‹
timestamp
string
required
Example:

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

ā€‹
message
string
required
Example:

"Success"

ā€‹
data
object