Public API Documentation

The TikkieTrack Public API lets you automate time tracking, project management and payroll processes directly from your own applications. Use the reference below to understand how to connect, what to expect from each endpoint and how to test requests quickly.

Tip: Replace https://example.com in the examples with your own installation URL. Generate a personal access token in your account settings to authenticate requests.

Getting Started

Use this section as a checklist before calling the API.

Base configuration

Authentication

1. Generate a personal access token from Settings → API Tokens inside TikkieTrack.
2. Add the token to every request using the Authorization: Bearer {token} header.
3. Keep tokens secret—rotate them regularly if you embed them in automations.

curl -H "Authorization: Bearer {token}" \
  https://example.com/api/v1/time-entries

Pagination

Paginated responses include meta and link objects that let you move between pages. When requesting larger collections, pass per_page to control the page size:

curl -H "Authorization: Bearer {token}" \
  "https://example.com/api/v1/time-entries?per_page=50"

Time Entries

Endpoints that let authenticated users record and manage time.

Endpoints

Filters for listing

Example request

curl -H "Authorization: Bearer {token}" \
  "https://example.com/api/v1/time-entries?q=meeting&status=open&start=2024-05-01&end=2024-05-31"

Example response (201 Created)

{
  "id": 5,
  "date": "2024-01-15",
  "hours": 2.5,
  "status": "open",
  "description": "Design meeting",
  "from_time": "2024-01-15 09:00:00",
  "till_time": "2024-01-15 11:30:00",
  "project": {
    "id": 1,
    "name": "Website Redesign",
    "description": "Revamp",
    "budget": 10000,
    "start_date": "2024-01-01",
    "end_date": "2024-12-31"
  }
}

Projects

Projects group related work. You can create them programmatically when onboarding new clients.

Endpoints

Example request

curl -X POST https://example.com/api/v1/projects \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Website Redesign",
    "description": "Revamp",
    "start_date": "2024-01-01",
    "end_date": "2024-12-31"
  }'

Example response (201 Created)

{
  "id": 1,
  "name": "Website Redesign",
  "description": "Revamp",
  "budget": 10000,
  "start_date": "2024-01-01",
  "end_date": "2024-12-31"
}

Services

Services describe the billable offerings your organisation provides.

Endpoints

Example request

curl -X POST https://example.com/api/v1/services \
  -H "Authorization: Bearer {token}" \
  -F "name=Consulting" \
  -F "description=Hourly consulting" \
  -F "file=@consulting.pdf"

Example response (201 Created)

{
  "id": 1,
  "name": "Consulting",
  "description": "Hourly consulting",
  "original_name": "consulting.pdf",
  "file_path": "https://example.com/storage/services/consulting.pdf"
}

Materials

Materials capture physical goods or resources tracked alongside services.

Endpoints

Example request

curl -X POST https://example.com/api/v1/materials \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Branded notebooks",
    "unit_cost": 4.5,
    "description": "Giveaways for client meetings"
  }'

Example response (201 Created)

{
  "id": 7,
  "name": "Branded notebooks",
  "unit_cost": 4.5,
  "description": "Giveaways for client meetings",
  "created_at": "2024-05-14T09:18:00Z",
  "updated_at": "2024-05-14T09:18:00Z"
}

Support & Feedback

Need help or have suggestions? Reach out to our team at support@tikkietrack.com and we'll be glad to assist.