Skip to main content
GET
/
api
/
statuses
# Get all candidate statuses
curl --request GET \
  --url https://api.harmonyforstaffing.com/api/statuses?type=CANDIDATE \
  --header 'Authorization: Bearer <token>'

# Get specific status
curl --request GET \
  --url https://api.harmonyforstaffing.com/api/statuses?id=123 \
  --header 'Authorization: Bearer <token>'

{
  "statuses": [
    {
      "id": 123,
      "name": "In Review",
      "type": "CANDIDATE",
      "description": "Candidate is being reviewed by the hiring team",
      "isDefault": false,
      "isActive": true,
      "dateAdded": 1679253000
    }
  ]
}
Retrieve a list of statuses or get details for a specific status.

​
Query Parameters

​
id
string
Optional status ID to get a specific status
​
type
string
Filter statuses by type

​
Response

​
statuses
array
List of status objects
# Get all candidate statuses
curl --request GET \
  --url https://api.harmonyforstaffing.com/api/statuses?type=CANDIDATE \
  --header 'Authorization: Bearer <token>'

# Get specific status
curl --request GET \
  --url https://api.harmonyforstaffing.com/api/statuses?id=123 \
  --header 'Authorization: Bearer <token>'

{
  "statuses": [
    {
      "id": 123,
      "name": "In Review",
      "type": "CANDIDATE",
      "description": "Candidate is being reviewed by the hiring team",
      "isDefault": false,
      "isActive": true,
      "dateAdded": 1679253000
    }
  ]
}