Zeitstrom API Documentation

Welcome to the Zeitstrom API documentation. This API allows you to integrate your applications with the Zeitstrom platform, enabling you to manage employees, track working time, handle absences, manage projects, and retrieve reports programmatically.

Overview

The Zeitstrom API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

All resources use UUIDs as their primary identifiers, returned as the id field. Every resource includes created_at and modified_at timestamps.

Base URL

All API requests should be made to the following base URL:

https://api.zeitstrom.com/api/v2/

Request Format

The API accepts JSON-encoded request bodies. Set the Content-Type header accordingly:

Headers

Content-Type: application/json
Authorization: Token <YOUR_API_TOKEN>

Pagination

List endpoints return paginated results. Use the limit and offset query parameters to control pagination.

Name
limit
Type
integer
Description
Maximum number of results to return. Defaults to 100, maximum 1000.
Name
offset
Type
integer
Description
Number of results to skip before returning. Defaults to 0.

Paginated Request

curl -X GET "https://api.zeitstrom.com/api/v2/employees/employees/?limit=25&offset=50" \
  -H "Authorization: Token <YOUR_API_TOKEN>"

Paginated Response

{
  "count": 150,
  "next": "https://api.zeitstrom.com/api/v2/employees/employees/?limit=25&offset=75",
  "previous": "https://api.zeitstrom.com/api/v2/employees/employees/?limit=25&offset=25",
  "results": [...]
}

Filtering

Most list endpoints support filtering through query parameters. Common patterns include:

Pipe-separated lists: ?employee_ids=uuid1|uuid2 to filter by multiple values
Date ranges: ?daterange=2024-01-01|2024-01-31 for date-bounded queries
Search: ?q=search+term for free-text search
Ordering: ?order=field_name to sort results (prefix with - for descending)
Archive filter: ?archived=true|false|all to include or exclude archived resources