Yey
Developers

API Reference

Build integrations with your ERP, payroll, or custom tooling using the REST API. Available on Growth and Scale plans.

Base URL

https://api.yeydigital.eu/api/v1

Authentication

Authorization: Bearer <API_KEY>

API access is available on Growth and Scale plans

To get your API key, go to Settings → API in your Yey account, or contact support.

Workers

GET/api/v1/workers
POST/api/v1/workers
GET/api/v1/workers/:id
PATCH/api/v1/workers/:id
DELETE/api/v1/workers/:id

Sites

GET/api/v1/sites
POST/api/v1/sites
GET/api/v1/sites/:id
POST/api/v1/sites/:id/workers

Attendance

GET/api/v1/attendance
POST/api/v1/attendance/checkin
POST/api/v1/attendance/checkout

Documents

GET/api/v1/documents
POST/api/v1/documents/upload
DELETE/api/v1/documents/:id

Example request

curl -X GET https://api.yeydigital.eu/api/v1/workers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "wkr_01abc...",
      "name": "João Silva",
      "nationality": "PT",
      "status": "active",
      "currentSiteId": "site_01xyz...",
      "documentsExpiringSoon": 1
    }
  ],
  "total": 47,
  "page": 1,
  "limit": 20
}
Request API access

Available on Growth and Scale plans