List employees
curl --request GET \
--url https://api.v3.andteam.com/v1/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.v3.andteam.com/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://api.v3.andteam.com/v1/employees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.v3.andteam.com/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))
}{
"data": [
{
"id": "<string>",
"employeeNumber": "<string>",
"firstName": "<string>",
"preferredName": "<string>",
"lastName": "<string>",
"workEmail": "<string>",
"workPhone": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"orgUnits": [
{
"level": "<string>",
"name": "<string>"
}
],
"location": "<string>",
"companyId": "<string>",
"managerId": "<string>",
"employmentType": "<string>",
"status": "upcoming",
"startDate": "<string>",
"lastDay": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"positionNumber": "<string>",
"positionTitle": "<string>",
"reportsToPositionId": "<string>",
"personalEmail": "<string>",
"mobile": "<string>",
"homeAddress": {
"line1": "<string>",
"unitNumber": "<string>",
"complexName": "<string>",
"suburb": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"dateOfBirth": "<string>",
"nationality": "<string>",
"gender": "<string>",
"race": "<string>",
"eeDesignation": "<string>",
"disability": true,
"medicalAidMember": true
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}Directory
List employees
Needs the Directory field group. Filter by status, company_id, employee_number or work_email. updated_since returns only records changed after that instant.
GET
/
employees
List employees
curl --request GET \
--url https://api.v3.andteam.com/v1/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.v3.andteam.com/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://api.v3.andteam.com/v1/employees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.v3.andteam.com/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))
}{
"data": [
{
"id": "<string>",
"employeeNumber": "<string>",
"firstName": "<string>",
"preferredName": "<string>",
"lastName": "<string>",
"workEmail": "<string>",
"workPhone": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"orgUnits": [
{
"level": "<string>",
"name": "<string>"
}
],
"location": "<string>",
"companyId": "<string>",
"managerId": "<string>",
"employmentType": "<string>",
"status": "upcoming",
"startDate": "<string>",
"lastDay": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"positionNumber": "<string>",
"positionTitle": "<string>",
"reportsToPositionId": "<string>",
"personalEmail": "<string>",
"mobile": "<string>",
"homeAddress": {
"line1": "<string>",
"unitNumber": "<string>",
"complexName": "<string>",
"suburb": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"dateOfBirth": "<string>",
"nationality": "<string>",
"gender": "<string>",
"race": "<string>",
"eeDesignation": "<string>",
"disability": true,
"medicalAidMember": true
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Authorization: Bearer atk_live_…. Created in the API keys section of the Integrations settings; the secret is shown once.
Query Parameters
Page size, 1 to 500. Default 100.
Required range:
1 <= x <= 500The next_cursor of the previous page.
Only records changed after this instant (ISO 8601).
upcoming, active or left.
Available options:
upcoming, active, left One of the key's companies.
Exact employee number.
Exact work email.