GET
/
v1
/
positions
List positions
curl --request GET \
  --url https://staging.api.us.aptlydone.com/settings/v1/positions \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:43.411Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "5e30e192-a922-45d6-a35f-196c94bebd05",
        "tenantId": "b07b13fd-15ec-4d79-963c-3958a90c4f6e",
        "positionId": "10000",
        "positionName": "Senior Developer",
        "isSCIMProvisioned": false,
        "status": "ACTIVE",
        "isDeleted": false,
        "createdOn": "2025-01-13T12:34:59.300Z",
        "updatedOn": "2025-01-13T12:34:59.300Z",
        "groups": [
          {
            "groupName": "Engineering Team",
            "groupTypeName": "Organizations",
            "groupId": "52fb829d-da34-427e-a528-4d3baf5968ca",
            "groupTypeId": "e21d3dec-fa12-48ea-b800-71faa767394c",
            "parentId": 2,
            "parentName": "Technology Division",
            "createdAt": "2025-01-13T12:34:59.303Z",
            "updatedAt": "2025-01-13T12:34:59.303Z"
          }
        ],
        "delegationsReceived": 1,
        "delegationsIssued": 1
      }
    ]
  }
}

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:

"36b7756b-0cf7-40b7-a094-8c472bf0e034"

​
sourceType
string

Source type of the position (comma separated)

Example:

"All,Directory Sync"

​
groupIds
string

Group IDs (comma separated)

Example:

"df0b5767-a6d9-49ee-bf29-8b29e00f1346, ad212e15-bdb5-4940-9c35-0126e6568b94"

​
status
string

Status (comma separated)

Example:

"ACTIVE,INACTIVE"

​
search
string

Search by position name

Example:

"Developer"

​
sortBy
string

Field to sort by

Example:

"positionName"

​
sortOrder
enum<string>
default:asc

Sort order (asc/desc)

Available options:
asc,
desc
Example:

"asc"

​
select
string

Specific fields to select (comma separated)

Example:

""

​
fields
string
deprecated

Specific fields to select (comma separated) - DEPRECATED: Use select instead

Example:

"id,positionName"

​
selectedPositionIds
string

Comma separated Selected Position IDs

Example:

"abc65d4c-07c3-440f-904a-1a4ed9ac955a, f61d508c-20d0-4039-add1-0331936b8637"

​
createdDateStart
string

Creation date range - start date

Example:

"2024-01-01T00:00:00.000Z"

​
createdDateEnd
string

Creation date range - end date

Example:

"2024-12-31T23:59:59.999Z"

​
updatedDateStart
string

Last updated date range - start date

Example:

"2024-01-01T00:00:00.000Z"

​
updatedDateEnd
string

Last updated date range - end date

Example:

"2024-12-31T23:59:59.999Z"

​
issuerType
enum<string>

Delegation issuer type

Available options:
ROOT_AUTHORITY,
PERSONNEL_IN_POSITION,
POSITION_ONLY,
SPECIFIC_PERSONNEL
Example:

"ROOT_AUTHORITY"

​
issuerUserId
string

Delegation issuer user id

Example:

"242cb43e-36c4-4ce4-a905-87e20b0f49d7"

​
issuerPositionId
string

Delegation issuer position id

Example:

"30866b63-211d-4827-abed-2344579cefff"

​
delegationPathway
string
default:[]

Delegation Pathway (comma separated)

Example:

"Matrix,Functional"

​
recipientType
enum<string>

Delegation recipient type

Available options:
PERSONNEL_IN_POSITION,
POSITION_ONLY,
SPECIFIC_PERSONNEL
Example:

"PERSONNEL_IN_POSITION"

Response

200 - application/json

Positions list retrieved successfully

The response is of type object.