List published employee events

Needs the Directory field group. The thin events behind the webhooks, for a consumer that cannot receive them: ids, dates and the names of changed fields, never values. Order by occurredAt and sequence.

GET /events

List published employee events

cURL

curl --request GET \
  --url https://api.v3.andteam.com/v1/events \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "employee.hired",
      "occurredAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "employeeId": "<string>",
      "employeeNumber": "<string>",
      "companyId": "<string>",
      "effectiveDate": "<string>",
      "sequence": 123,
      "data": {
        "changedFields": [
          "employeeNumber"
        ],
        "startDate": "<string>",
        "lastDay": "<string>"
      },
      "links": {
        "employee": "<string>"
      }
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

Authorization: Bearer atk_live_…. Created in the API keys section of the Integrations settings; the secret is shown once.

Query Parameters

limit · integer · default: 100

Page size, 1 to 500. Default 100.

Required range: 1 <= x <= 500

cursor · string

The next_cursor of the previous page.

since · string<date-time>

Only events published after this instant (ISO 8601).

type · enum<string>

One event type.

Available options: employee.hired, employee.started, employee.changed, employee.leaving, employee.left, employee.hire_withdrawn, employee.termination_cancelled

company_id · string

One of the key's companies.

Response

200

application/json

OK

data · object[] · required

Show child attributes

next_cursor · string | null · required

Pass as cursor to read the next page. Null on the last page. There is no total.