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": "2025-06-25T06:16:49.192Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "userId": "90528ca7-f00f-4460-b943-8c6afed5368f",
        "name": "Antonio Nader Sr.",
        "positions": "International Communications Officer, Global Usability Orchestrator"
      }
    ]
  }
}

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:

"51ab5dea-346a-48de-9cf5-1992e05e88a1"

​
search
string

Search term to filter users or positions by name

Example:

"John Doe"

​
groupIds
string

Group IDs (comma separated)

Example:

"3ad8b8eb-5c00-4709-b03e-754dffd2a2e9, 6462f223-6268-413f-8a78-4c117a00a0a2"

​
userIds
string

User IDs (comma separated)

Example:

"cbb1a2cb-e5a8-437a-8691-da64eb56073b, 73977b93-2377-47d1-9e22-5fb54735673b"

​
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

The response is of type object.