List an employee's pay packages, newest first
curl --request GET \
--url https://api.v3.andteam.com/v1/employees/{id}/pay-history \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.v3.andteam.com/v1/employees/{id}/pay-history"
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/{id}/pay-history', 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/{id}/pay-history"
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>",
"kind": "hire",
"effectiveDate": "<string>",
"basis": "annual",
"currency": "ZAR",
"components": [
{
"componentId": "<string>",
"label": "<string>",
"amount": 123,
"frequency": "<string>"
}
],
"annualTotal": 123
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}Pay
List an employee's pay packages, newest first
Needs the Pay field group. Pay, approved by a holder of Sign off payroll. Packages in force so far, newest first: a change still to come is left out until its date. Never the reason note or who approved it. People in protected groups answer 404 unless the approver ticked Include protected groups.
GET
/
employees
/
{id}
/
pay-history
List an employee's pay packages, newest first
curl --request GET \
--url https://api.v3.andteam.com/v1/employees/{id}/pay-history \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.v3.andteam.com/v1/employees/{id}/pay-history"
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/{id}/pay-history', 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/{id}/pay-history"
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>",
"kind": "hire",
"effectiveDate": "<string>",
"basis": "annual",
"currency": "ZAR",
"components": [
{
"componentId": "<string>",
"label": "<string>",
"amount": 123,
"frequency": "<string>"
}
],
"annualTotal": 123
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}Authorizations
apiKeyoauth
Authorization: Bearer atk_live_… (a sandbox's keys are atk_test_…). Created in the API keys section of the Integrations settings; the secret is shown once.
Path Parameters
The employee id.
Query Parameters
One of the key's companies.
Page size, 1 to 500. Default 100.
Required range:
1 <= x <= 500The next_cursor of the previous page.