Skip to main content
GET
/
employees
List all employees
curl --request GET \
  --url https://{base_url}/api/v1/employees \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{base_url}/api/v1/employees"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{base_url}/api/v1/employees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{base_url}/api/v1/employees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://{base_url}/api/v1/employees"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{base_url}/api/v1/employees")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{base_url}/api/v1/employees")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "2095_1144974",
    "address": {
      "id": "",
      "city": "Christchurch",
      "country": "",
      "line1": "123 Fitzgerald Avenue",
      "line2": "",
      "postalCode": 8011,
      "state": "Canterbury",
      "suburb": ""
    },
    "contractedHours": [
      {
        "id": "2443_312283",
        "day": 1,
        "department": {
          "id": "2784_119",
          "name": "Deli"
        },
        "finishTime": null,
        "minutesTotal": 480,
        "minutesWorking": 480,
        "role": {
          "id": "2213_6559",
          "name": "Retail Assistant"
        },
        "shift": {
          "id": "2786_12120",
          "name": "Morning"
        },
        "startTime": null,
        "week": 1,
        "workPattern": false
      },
      {
        "id": "2443_312284",
        "day": 2,
        "department": {
          "id": "2784_119",
          "name": "Deli"
        },
        "finishTime": "T07:00:00.000",
        "minutesTotal": 360,
        "minutesWorking": 360,
        "role": {
          "id": "2213_6559",
          "name": "Retail Assistant"
        },
        "shift": null,
        "startTime": "T01:00:00.000",
        "week": 1,
        "workPattern": false
      }
    ],
    "firstNames": "Jane",
    "lastName": "Smith",
    "payRollCode": ""
  }
]

Authorizations

Authorization
string
header
required

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

Response

A list of employees

id
string

The unique identifier for the employee

Example:

"2095_1144974"

address
object
contractedHours
object[]

A list of the employee's contracted hours entries across the week

firstNames
string

The employee's first name(s)

Example:

"Jane"

lastName
string

The employee's last name

Example:

"Smith"

payRollCode
string

The payroll code associated with this employee. Empty string if not assigned.

Example:

""