Skip to main content

Use the POS Time Tracker API

Generate an Enterprise API key and retrieve staff and shift data from the POS Time Tracker API.

Written by Phillip Araujo

Who can use the API

The POS Time Tracker API is an Enterprise-plan feature. It is a read-only API for staff and shift data.

If the store is not on Enterprise, the API Key section doesn’t appear in Settings at all, and API requests return an error that the shop is not on the enterprise plan.

Generate an API key

  1. Open POS Time Tracker in Shopify Admin.

  2. Go to Settings.

  3. Scroll to the API Key section.

  4. Click Generate New API Key.

If a key already exists, the field shows the current key. Use Show or Hide to reveal it, and Copy to copy it. Generating a new key replaces the previous key and shows “API key generated successfully”.

The Settings section also links to POS Time Tracker API docs at /api/docs in the app.

Authenticate requests

The API uses Basic authentication over HTTPS:

  • Username: your Shopify store domain (for example, amazing-store.myshopify.com)

  • Password: your API key

Send every request to https://postimetracker.com/api with an Authorization header using Basic Auth. HTTP requests are redirected to HTTPS. Responses are JSON. Missing or invalid credentials return HTTP 401 with { "message": "Unauthorized" }.

Example:

curl --user "amazing-store.myshopify.com:YOUR_API_KEY" \
  "https://postimetracker.com/api/entries?afterDate=2026-06-01&beforeDate=2026-06-07"

Endpoints

  • GET /entries: a page of shifts. Optional filters include staffIds (comma-separated Staff IDs that already exist in POS Time Tracker), afterDate, beforeDate, and page.

  • GET /staff: a page of staff members and their current status. Optional filters include staffIds and page.

Date filters on /entries select whole shifts by the day the shift started. A selected shift can still end after that day; its end time, breaks, and duration are included. Omitting page, or passing it empty, returns page 1. /entries returns up to 1,000 shifts per page, and /staff returns up to 50 staff members per page. A page beyond the available results returns an empty array.

POS Time Tracker API docs listing GET /entries and GET /staff

Rate and usage limits

Limits apply per API key, per hour. The default limit is 30 requests per hour. Authenticated requests count even when query validation returns HTTP 400 (for example, invalid staff IDs or dates). The first request after a window resets starts a new window and counts as its first request.

If you exceed a limit, the API returns HTTP 429 with { "message": "Too many requests" }. Successful responses and authenticated validation errors include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

For the full request and response schemas, open POS Time Tracker API from Settings (the in-app docs at /api/docs).

Did this answer your question?