Skip to main content
GET
/
activities
List all activities
curl --request GET \
  --url https://{base_url}/api/v1/activities \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "2760_182",
    "costCentre": "",
    "isBreak": false,
    "isPaid": true,
    "name": "Annual Leave",
    "payRollCodes": [
      {
        "id": "4630_116",
        "code": "Annual Leave",
        "payRollProvider": "DataPay"
      }
    ]
  },
  {
    "id": "2760_180",
    "costCentre": "",
    "isBreak": true,
    "isPaid": true,
    "name": "Break",
    "payRollCodes": [
      {
        "id": "4630_114",
        "code": "Break",
        "payRollProvider": "DataPay"
      }
    ]
  },
  {
    "id": "2760_179",
    "costCentre": "",
    "isBreak": true,
    "isPaid": false,
    "name": "Lunch Break",
    "payRollCodes": [
      {
        "id": "4630_113",
        "code": "Lunch Break",
        "payRollProvider": "DataPay"
      }
    ]
  },
  {
    "id": "2760_181",
    "costCentre": "",
    "isBreak": false,
    "isPaid": true,
    "name": "Sick Leave",
    "payRollCodes": [
      {
        "id": "4630_115",
        "code": "Sick Leave",
        "payRollProvider": "DataPay"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Access token obtained from /oauth/token. Pass as Authorization: Bearer {token}

Response

A list of activities

​
id
string

The unique identifier for the activity

Example:

"2760_182"

​
costCentre
string

The cost centre associated with the activity. Empty string if not assigned.

Example:

""

​
isBreak
boolean

Whether this activity is classified as a break

Example:

false

​
isPaid
boolean

Whether this activity is paid

Example:

true

​
name
string

The display name of the activity

Example:

"Annual Leave"

​
payRollCodes
object[]

A list of payroll codes associated with this activity