Get Positions

Returns a list of positions from the system. Optional status and label query parameters narrow the results.

GET /positions

cURL

cURL

curl --request GET \
  --url https://api.alex.com/v1/api/positions \
  --header 'X-API-Key: <api-key>'

200

[
  {
    "positionId": "<string>",
    "name": "<string>",
    "externalJobId": "12345"
  }
]

Authorizations

X-API-Key · string · header · required

Query Parameters

status · enum<string>

Filter by position status. Accepts "Active" or "Inactive" (case-insensitive).

Available options: Active, Inactive

label · string

Filter by label name (case-insensitive exact match). Returns positions that have a label with this name attached.

Response

200

application/json

Positions response

positionId · string

The unique identifier for the position

name · string

The name of this position

externalJobId · string | null

The ID of this position's job in the connected ATS, or null if there is no linked ATS record

Example:

"12345"