Employee Area

Served for sessions and personal keys of accounts linked to an employee record. Every endpoint only ever touches the caller's own data, and needs no role permission.

For how this area works day to day, see the Employee Area guide.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

• GET/me/activity

  Changes made to your record: who, what and when

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/announcements

  Announcements for you, newest first

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/announcements/{id}:acknowledge

  Acknowledge an announcement

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/availability

  Your availability

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/availability

  Add an availability window

  Key—not allowed

  Peopleself

  Featureemployee_area
• DELETE/me/availability/{id}

  Remove an availability window

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/documents

  Documents shared with you

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/export

  Download everything PurrOS stores about you (ZIP of JSON and CSV)

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/open-shifts

  Published open shifts you can pick up

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/pay

  Your pay rate history and estimated gross pay per pay period

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/payslips

  Your payslips

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/profile

  Your profile

  Key—not allowed

  Peopleself

  Featureemployee_area
• PATCH/me/profile

  Update your contact details and emergency contacts

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/punch-corrections

  Your punch correction requests

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/punch-corrections

  Ask your manager to fix a missed or wrong punch

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/punch-corrections/{id}:cancel

  Cancel a pending correction request

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/punches

  Your punches (from/to are RFC 3339 times)

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/shift-swaps

  Swap requests you made or were offered

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/shift-swaps

  Offer one of your shifts to a co-worker

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/shifts

  Your published shifts (from/to are RFC 3339 times)

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/shifts/{id}:claim

  Pick up an open shift at your location

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/time-off/balances

  Your time-off balances

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/time-off/requests

  Your time-off requests

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/time-off/requests

  Request time off

  Key—not allowed

  Peopleself

  Featureemployee_area
• POST/me/time-off/requests/{id}:cancel

  Cancel one of your time-off requests

  Key—not allowed

  Peopleself

  Featureemployee_area
• GET/me/timesheets

  Your timesheets

  Key—not allowed

  Peopleself

  Featureemployee_area