PurpletGo API Reference

The PurpletGo REST API gives developers programmatic access to offboarding records, the employee directory, and webhook subscriptions. Use it to trigger offboardings from your HRIS, sync employee data into your own systems, or get notified the moment an offboarding changes status.

Base URL

https://app.purpletgo.com/api/v1

Every endpoint under /api/v1 requires a valid API key. See Authentication for details.

Explore the API

Authentication→API Keys→Errors & Rate Limiting→Employees→Offboarding→Webhooks→

Request format

Requests with a body must use Content-Type: application/json.

curl https://app.purpletgo.com/api/v1/employees \
  -H "Authorization: Bearer fnl_live_••••••••••••••••••••••••••••••••" \
  -H "Content-Type: application/json"

Response format

All responses return JSON. Successful responses use 2xx status codes. Error responses follow a single, consistent envelope:

{
  "error": "Resource not found"
}

There's no separate error code field - client code should key off the HTTP status and, where it matters, the error message text.

Pagination

List endpoints (GET /offboardings, GET /employees) accept page and limit query parameters and return results wrapped in data and meta:

{
  "data": [ ... ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 124,
    "total_pages": 7,
    "has_next": true
  }
}

Parameter	Default	Max
`page`	`1`	-
`limit`	`20`	`100`

GET /webhooks is not paginated - it returns a plain array of all webhooks registered for your organisation.

Versioning

The current API version is v1, and it's the only version - the /api/v1 prefix is part of every request path. Breaking changes will be announced in the changelog ahead of time.

Authentication