API Reference
Employees

Employees

The employees endpoint gives you read access to the profiles PurpletGo already has on file for your organisation - useful for cross-referencing offboarding records against your own HRIS.

Base path: /api/v1/employees

This is a read-only endpoint. Creating, updating, and deleting employees is done from the PurpletGo dashboard (or your HRIS sync) - not through the public API.

List employees

GET /api/v1/employees

Required scope: employees:read

Returns everyone in your organisation's directory, sorted alphabetically by name.

Query parameters

ParamTypeDescription
pageintegerPage number (default: 1)
limitintegerResults per page (default: 20, max: 100)

Response 200 OK

{
  "data": [
    {
      "id": "3f9c8b1a-...",
      "full_name": "Jordan Lee",
      "email": "jordan@acme.com",
      "role": "Senior Engineer",
      "department": "Engineering",
      "created_at": "2024-03-15T09:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 84,
    "total_pages": 5,
    "has_next": true
  }
}

There's no status, phone, githubUsername, or workerType field on this record - those live on internal employee records inside the app but aren't exposed here. If your integration needs that level of detail, it isn't currently available through the public API.

Related

  • Offboarding - create an offboarding for one of these employees
API KeysOffboarding