Wersja zapoznawcza dla deweloperów

REST API Sandtime.io

Use the Sandtime.io REST API from cURL or any standard HTTP client. The current reference documents verified operations across public route paths, plus a machine-readable OpenAPI schema.

Przeglądaj dokumentację trasPobierz OpenAPI JSON

Kiedy używać REST

REST API najlepiej sprawdza się wtedy, gdy Twoje środowisko obsługuje wyłącznie zwykłe HTTP, gdy chcesz korzystać z przykładów cURL albo gdy potrzebujesz bezpośredniej kontroli nad ładunkami i adresami URL endpointów.

W przypadku agentów AI Sandtime.io nadal zaleca najpierw serwer MCP, ponieważ MCP udostępnia przepływy pracy wyższego poziomu i wygodniejsze kontrakty narzędzi. Wybierz REST, gdy MCP jest niedostępne lub gdy użytkownik wyraźnie prosi o surowe HTTP.

  • Użyj REST, gdy potrzebujesz bezpośredniej kontroli nad HTTP, skryptów cURL, zadań CI lub standardowego klienta API.
  • Użyj pliku OpenAPI JSON, gdy chcesz generować klientów, walidować żądania lub przekazać schemat do narzędzi.
  • Zamiast tego użyj MCP, gdy klient AI może bezpośrednio wywoływać narzędzia i korzystać z przepływów pracy wyższego poziomu.

Uwierzytelnij się tokenem Bearer

Żądania REST trafiają bezpośrednio na nazwę hosta Twojej organizacji, na przykład https://acme.sandtime.io/api. Nazwa hosta identyfikuje przestrzeń roboczą, więc REST nie wymaga nagłówka X-Sandtime-Organization używanego przez MCP.

curl -X GET 'https://your-organization.sandtime.io/api/auth' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Uwierzytelnianie nadal jest w wersji deweloperskiej. Obecnie token Bearer uzyskujesz, kopiując go z ciasteczka sesyjnego Sandtime.io. To odpowiada bieżącemu przepływowi uwierzytelniania MCP, a dedykowany przepływ tokenów jest nadal w budowie.

Dokumenty czytelne dla maszyn i konwencje API

Wszystko poniżej korzysta z tego samego współdzielonego rejestru tras, który generuje także plik OpenAPI JSON.

OpenAPI JSON

Schemat OpenAPI do pobrania do generowania klientów, walidatorów i narzędzi API.

https://sandtime.io/api/openapi.json

SKILL.md

Przewodnik integracyjny czytelny dla maszyn dla agentów wybierających między MCP a surowym HTTP.

https://sandtime.io/SKILL.md

Dokumentacja MCP

Integracja wyższego poziomu dla Claude Code, Codex i innych klientów MCP.

https://sandtime.io/mcp

Konwencje żądań

  • Bazowy URL: jedna przestrzeń robocza na host, na przykład https://acme.sandtime.io/api.
  • Uwierzytelnianie: wyślij nagłówek Authorization: Bearer <token>. Obecnie token jest kopiowany z ciasteczka sandtime_access_token.
  • Format: żądania i odpowiedzi używają JSON. Poniższe przykłady dla poszczególnych tras odzwierciedlają bieżącą implementację serwera.
  • Przepływ pracy: rozwiązuj identyfikatory za pomocą żądań odczytu przed zapisami, aby nigdy nie zgadywać identyfikatorów projektów, użytkowników, członków ani raportów.

Grupy tras

Wejdź do wybranej przestrzeni nazw, a potem sprawdź każdą ścieżkę trasy, obsługiwane metody, przykłady ciał żądań i przykładowe odpowiedzi.

Workspace

Workspace discovery, organization settings, and authentication helpers.

Activities

Time entry CRUD for manual logging, timers, and admin corrections.

Projects

Projects, memberships, and project-specific revenue rates.

Users

Users, personal preferences, and organization-level cost rates.

Reports

Saved report definitions for dashboards, billing, and exports.

Geofences

Geofence definitions plus mobile enter and exit triggers.

Requests

Approval and assignment workflows live under /requests.

Timesheets

Explicit timesheet locks, automatic lock execution, and reminder delivery.

Billing

Billing, plan changes, and checkout helpers.

Workspace

Workspace discovery, organization settings, and authentication helpers.

/auth

Authentication snapshot

Read the current cookie-backed auth snapshot or list the organizations available to the signed-in user.

GET

Get the current auth snapshot

Returns the current user email, active organization domain, and the same Bearer token currently extracted from the session cookie.

Status odpowiedzi: 200Identyfikator operacji: get-auth
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/auth' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "domain": "acme",
  "email": "alex.rivera@example.com",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example"
}
/organizations

Organizations

List the active organizations available to the signed-in user account.

GET

List active organizations

Returns the active workspaces available to the current user across Sandtime.io.

Status odpowiedzi: 200Identyfikator operacji: get-organizations
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/organizations' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
[
  {
    "active": true,
    "domain": "acme",
    "name": "Acme Studio"
  },
  {
    "active": true,
    "domain": "northwind",
    "name": "Northwind Consulting"
  }
]
/organization

Organization settings

Read, update, or permanently remove the current organization.

GET

Get organization settings

Returns the organization settings loaded for the current hostname.

Status odpowiedzi: 200Identyfikator operacji: get-organization
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/organization' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "coreHours": {
    "end": "17:00",
    "start": "09:00"
  },
  "currency": "USD",
  "holidays": {
    "country": "US",
    "excluded": []
  },
  "id": "8a4affba-df59-47bd-8173-d175e76efd15",
  "lockingTimesheets": {
    "enabled": false,
    "timeZone": null,
    "week": null,
    "year": null
  },
  "name": "Acme Studio",
  "notes": "Weekly client delivery team.",
  "onboarding": {
    "assignMembers": {
      "done": true,
      "viewed": true
    },
    "inviteMembers": {
      "done": true,
      "viewed": true
    },
    "organization": {
      "done": true,
      "viewed": true
    },
    "preferences": {
      "done": false,
      "viewed": true
    },
    "projects": {
      "done": true,
      "viewed": true
    }
  },
  "plan": "free",
  "rounding": {
    "enabled": false,
    "interval": 900000,
    "mode": "NEAREST"
  },
  "timeZone": "Europe/Warsaw"
}
PUT

Update organization settings

Updates mutable organization settings such as currency, notes, core hours, holidays, rounding, and timesheet locking.

Status odpowiedzi: 200Identyfikator operacji: put-organization
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/organization' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "coreHours": {
    "end": "16:00",
    "start": "08:00"
  },
  "currency": "EUR",
  "notes": "Updated delivery schedule for the summer quarter.",
  "rounding": {
    "enabled": true,
    "interval": 900000,
    "mode": "NEAREST"
  },
  "timeZone": "Europe/Warsaw"
}'
Przykład ciała żądania
{
  "coreHours": {
    "end": "16:00",
    "start": "08:00"
  },
  "currency": "EUR",
  "notes": "Updated delivery schedule for the summer quarter.",
  "rounding": {
    "enabled": true,
    "interval": 900000,
    "mode": "NEAREST"
  },
  "timeZone": "Europe/Warsaw"
}
Przykład odpowiedzi
{
  "coreHours": {
    "end": "17:00",
    "start": "09:00"
  },
  "currency": "USD",
  "holidays": {
    "country": "US",
    "excluded": []
  },
  "id": "8a4affba-df59-47bd-8173-d175e76efd15",
  "lockingTimesheets": {
    "enabled": false,
    "timeZone": null,
    "week": null,
    "year": null
  },
  "name": "Acme Studio",
  "notes": "Weekly client delivery team.",
  "onboarding": {
    "assignMembers": {
      "done": true,
      "viewed": true
    },
    "inviteMembers": {
      "done": true,
      "viewed": true
    },
    "organization": {
      "done": true,
      "viewed": true
    },
    "preferences": {
      "done": false,
      "viewed": true
    },
    "projects": {
      "done": true,
      "viewed": true
    }
  },
  "plan": "free",
  "rounding": {
    "enabled": false,
    "interval": 900000,
    "mode": "NEAREST"
  },
  "timeZone": "Europe/Warsaw"
}
DELETE

Delete the current organization

Deletes the current organization. This action is restricted to administrators and may return a redirect URL for follow-up account cleanup.

Status odpowiedzi: 200Identyfikator operacji: delete-organization
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/organization' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "domain": "acme",
  "redirectUrl": "https://sandtime.io/offboarding-thank-you"
}
/organization/rename

Organization rename

Rename the current organization subdomain to a new available workspace hostname.

POST

Rename the organization subdomain

Starts an organization rename from the current subdomain to the new desired subdomain.

Status odpowiedzi: 200Identyfikator operacji: post-organization-rename
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/organization/rename' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "acme-europe"
}'
Przykład ciała żądania
{
  "domain": "acme-europe"
}
Przykład odpowiedzi
{
  "domain": "acme-europe"
}

Activities

Time entry CRUD for manual logging, timers, and admin corrections.

/activities

Activity collection

List all activities visible to the current workspace context or create a new time entry.

GET

List activities

Returns an ID-keyed map of activity records visible to the current user.

Status odpowiedzi: 200Identyfikator operacji: get-activities
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/activities' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302": {
    "billable": true,
    "endedAt": "2026-07-03T08:30:00.000Z",
    "id": "c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302",
    "name": "Implement API docs page",
    "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "startedAt": "2026-07-03T07:00:00.000Z",
    "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
  }
}
POST

Create an activity

Creates a new activity. Send `pending: true` with no `endedAt` when you want an open timer.

Status odpowiedzi: 200Identyfikator operacji: post-activities
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/activities' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "billable": true,
  "endedAt": "2026-07-03T10:30:00+02:00",
  "name": "Implement API docs page",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "startedAt": "2026-07-03T09:00:00+02:00"
}'
Przykład ciała żądania
{
  "billable": true,
  "endedAt": "2026-07-03T10:30:00+02:00",
  "name": "Implement API docs page",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "startedAt": "2026-07-03T09:00:00+02:00"
}
Przykład odpowiedzi
{
  "billable": true,
  "endedAt": "2026-07-03T08:30:00.000Z",
  "id": "c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302",
  "name": "Implement API docs page",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "startedAt": "2026-07-03T07:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
/activities/{activityId}

Single activity

Read, update, or delete a single activity by ID.

Parametry ścieżki

  • activityId: The activity identifier.
GET

Get an activity

Returns one activity record when the ID exists and the current user can see it.

Status odpowiedzi: 200Identyfikator operacji: get-activities-activityId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/activities/c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "billable": true,
  "endedAt": "2026-07-03T08:30:00.000Z",
  "id": "c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302",
  "name": "Implement API docs page",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "startedAt": "2026-07-03T07:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
PUT

Update an activity

Updates one activity. Typical changes include timestamps, billable status, title, and project assignment.

Status odpowiedzi: 200Identyfikator operacji: put-activities-activityId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/activities/c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "billable": false,
  "endedAt": "2026-07-03T11:00:00+02:00",
  "name": "Polish the REST API guide"
}'
Przykład ciała żądania
{
  "billable": false,
  "endedAt": "2026-07-03T11:00:00+02:00",
  "name": "Polish the REST API guide"
}
Przykład odpowiedzi
{
  "billable": false,
  "endedAt": "2026-07-03T09:00:00.000Z",
  "id": "c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302",
  "name": "Polish the REST API guide",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "startedAt": "2026-07-03T07:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
DELETE

Delete an activity

Deletes one activity by ID.

Status odpowiedzi: 200Identyfikator operacji: delete-activities-activityId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/activities/c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}

Projects

Projects, memberships, and project-specific revenue rates.

/projects

Project collection

List all projects visible to the user or create a new project.

GET

List projects

Returns an ID-keyed map of projects.

Status odpowiedzi: 200Identyfikator operacji: get-projects
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/projects' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001": {
    "archived": false,
    "avatar": null,
    "billable": true,
    "id": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "name": "Website refresh",
    "notes": "Main client delivery project."
  }
}
POST

Create a project

Creates a project and automatically adds the creating administrator as a project member.

Status odpowiedzi: 200Identyfikator operacji: post-projects
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/projects' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "billable": true,
  "name": "Website refresh",
  "notes": "Main client delivery project."
}'
Przykład ciała żądania
{
  "billable": true,
  "name": "Website refresh",
  "notes": "Main client delivery project."
}
Przykład odpowiedzi
{
  "archived": false,
  "avatar": null,
  "billable": true,
  "id": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "name": "Website refresh",
  "notes": "Main client delivery project."
}
/projects/{projectId}

Single project

Read, update, or delete a single project.

Parametry ścieżki

  • projectId: The project identifier.
GET

Get a project

Returns one project by ID.

Status odpowiedzi: 200Identyfikator operacji: get-projects-projectId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "archived": false,
  "avatar": null,
  "billable": true,
  "id": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "name": "Website refresh",
  "notes": "Main client delivery project."
}
PUT

Update a project

Updates project metadata such as notes, billable status, archived state, or avatar.

Status odpowiedzi: 200Identyfikator operacji: put-projects-projectId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "billable": false,
  "notes": "Internal redesign and QA support."
}'
Przykład ciała żądania
{
  "billable": false,
  "notes": "Internal redesign and QA support."
}
Przykład odpowiedzi
{
  "archived": false,
  "avatar": null,
  "billable": false,
  "id": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "name": "Website refresh",
  "notes": "Internal redesign and QA support."
}
DELETE

Delete a project

Deletes a project permanently.

Status odpowiedzi: 200Identyfikator operacji: delete-projects-projectId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}
/projects/{projectId}/members

Project members

List or create project members inside one project.

Parametry ścieżki

  • projectId: The project identifier.
GET

List project members

Returns an ID-keyed map of members assigned to the project.

Status odpowiedzi: 200Identyfikator operacji: get-projects-projectId-members
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04": {
    "archived": false,
    "assignedBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
    "id": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
    "notes": "Frontend owner",
    "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "role": "Administrator",
    "tags": [
      "design-system",
      "client-facing"
    ],
    "title": "Frontend Lead",
    "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
  }
}
POST

Create a project member

Assigns a user to the project and optionally stores role, title, notes, and tags.

Status odpowiedzi: 200Identyfikator operacji: post-projects-projectId-members
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "notes": "Frontend owner",
  "role": "Administrator",
  "tags": [
    "design-system",
    "client-facing"
  ],
  "title": "Frontend Lead",
  "userId": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af"
}'
Przykład ciała żądania
{
  "notes": "Frontend owner",
  "role": "Administrator",
  "tags": [
    "design-system",
    "client-facing"
  ],
  "title": "Frontend Lead",
  "userId": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af"
}
Przykład odpowiedzi
{
  "archived": false,
  "assignedBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
  "notes": "Frontend owner",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "role": "User",
  "tags": [
    "design-system",
    "client-facing"
  ],
  "title": "Product Designer",
  "userId": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af"
}
/projects/{projectId}/members/{memberId}

Single project member

Read, update, or remove a single project member record.

Parametry ścieżki

  • projectId: The project identifier.
  • memberId: The project member identifier.
GET

Get a project member

Returns one project membership by member ID.

Status odpowiedzi: 200Identyfikator operacji: get-projects-projectId-members-memberId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "archived": false,
  "assignedBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
  "notes": "Frontend owner",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "role": "Administrator",
  "tags": [
    "design-system",
    "client-facing"
  ],
  "title": "Frontend Lead",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
PUT

Update a project member

Updates role, title, tags, notes, or archived state for one project member.

Status odpowiedzi: 200Identyfikator operacji: put-projects-projectId-members-memberId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "notes": "Delivery owner",
  "role": "User",
  "tags": [
    "handover",
    "qa"
  ],
  "title": "Delivery Manager"
}'
Przykład ciała żądania
{
  "notes": "Delivery owner",
  "role": "User",
  "tags": [
    "handover",
    "qa"
  ],
  "title": "Delivery Manager"
}
Przykład odpowiedzi
{
  "archived": false,
  "assignedBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
  "notes": "Delivery owner",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "role": "User",
  "tags": [
    "handover",
    "qa"
  ],
  "title": "Delivery Manager",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
DELETE

Delete a project member

Removes the member from the project.

Status odpowiedzi: 200Identyfikator operacji: delete-projects-projectId-members-memberId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}
/projects/{projectId}/members/{memberId}/rates/revenue

Member revenue rates

List or create revenue rates for one project member.

Parametry ścieżki

  • projectId: The project identifier.
  • memberId: The project member identifier.
GET

List member revenue rates

Returns an ID-keyed map of revenue rates for the selected project member.

Status odpowiedzi: 200Identyfikator operacji: get-projects-projectId-members-memberId-rates-revenue
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04/rates/revenue' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "e6dd7425-f0ef-403c-8f21-5fe1931cc9a9": {
    "currency": "USD",
    "from": "2026-07-01T00:00:00.000Z",
    "id": "e6dd7425-f0ef-403c-8f21-5fe1931cc9a9",
    "memberId": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
    "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "taxRate": 23,
    "to": "2026-12-31T23:59:59.000Z",
    "value": 145
  }
}
POST

Create a member revenue rate

Creates a dated revenue rate window for a project member.

Status odpowiedzi: 200Identyfikator operacji: post-projects-projectId-members-memberId-rates-revenue
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04/rates/revenue' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 145
}'
Przykład ciała żądania
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 145
}
Przykład odpowiedzi
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00.000Z",
  "id": "e6dd7425-f0ef-403c-8f21-5fe1931cc9a9",
  "memberId": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59.000Z",
  "value": 145
}
/projects/{projectId}/members/{memberId}/rates/revenue/{revenueId}

Single member revenue rate

Read, update, or delete one revenue rate window.

Parametry ścieżki

  • projectId: The project identifier.
  • memberId: The project member identifier.
  • revenueId: The revenue rate identifier.
GET

Get a member revenue rate

Returns one revenue rate record.

Status odpowiedzi: 200Identyfikator operacji: get-projects-projectId-members-memberId-rates-revenue-revenueId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04/rates/revenue/e6dd7425-f0ef-403c-8f21-5fe1931cc9a9' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00.000Z",
  "id": "e6dd7425-f0ef-403c-8f21-5fe1931cc9a9",
  "memberId": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59.000Z",
  "value": 145
}
PUT

Update a member revenue rate

Updates one revenue rate window.

Status odpowiedzi: 200Identyfikator operacji: put-projects-projectId-members-memberId-rates-revenue-revenueId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04/rates/revenue/e6dd7425-f0ef-403c-8f21-5fe1931cc9a9' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 155
}'
Przykład ciała żądania
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 155
}
Przykład odpowiedzi
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00.000Z",
  "id": "e6dd7425-f0ef-403c-8f21-5fe1931cc9a9",
  "memberId": "3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "taxRate": 23,
  "to": "2026-12-31T23:59:59.000Z",
  "value": 155
}
DELETE

Delete a member revenue rate

Deletes one revenue rate record.

Status odpowiedzi: 200Identyfikator operacji: delete-projects-projectId-members-memberId-rates-revenue-revenueId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04/rates/revenue/e6dd7425-f0ef-403c-8f21-5fe1931cc9a9' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}

Users

Users, personal preferences, and organization-level cost rates.

/users

User collection

List all users in the current organization or invite a new member.

GET

List users

Returns an ID-keyed map of organization users.

Status odpowiedzi: 200Identyfikator operacji: get-users
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/users' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d": {
    "archived": false,
    "avatar": null,
    "email": "alex.rivera@example.com",
    "id": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
    "name": "Alex Rivera",
    "phone": "+1 415 555 0102",
    "role": "Administrator",
    "title": "Operations Lead"
  }
}
POST

Create or invite a user

Invites a user to the current organization. Existing users are re-invited instead of duplicated.

Status odpowiedzi: 200Identyfikator operacji: post-users
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/users' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "sam.lee@example.com",
  "name": "Sam Lee",
  "role": "User",
  "title": "Product Designer"
}'
Przykład ciała żądania
{
  "email": "sam.lee@example.com",
  "name": "Sam Lee",
  "role": "User",
  "title": "Product Designer"
}
Przykład odpowiedzi
{
  "archived": false,
  "avatar": null,
  "email": "sam.lee@example.com",
  "id": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "name": "Sam Lee",
  "phone": "+1 415 555 0102",
  "role": "User",
  "title": "Product Designer"
}
/users/{userId}

Single user

Read, update, or remove a single user.

Parametry ścieżki

  • userId: The user identifier.
GET

Get a user

Returns one user record.

Status odpowiedzi: 200Identyfikator operacji: get-users-userId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "archived": false,
  "avatar": null,
  "email": "alex.rivera@example.com",
  "id": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "name": "Alex Rivera",
  "phone": "+1 415 555 0102",
  "role": "Administrator",
  "title": "Operations Lead"
}
PUT

Update a user

Updates one user. Administrators can change role and archived state. Users can update their own profile fields.

Status odpowiedzi: 200Identyfikator operacji: put-users-userId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "archived": false,
  "phone": "+1 415 555 0188",
  "role": "Administrator",
  "title": "Head of Operations"
}'
Przykład ciała żądania
{
  "archived": false,
  "phone": "+1 415 555 0188",
  "role": "Administrator",
  "title": "Head of Operations"
}
Przykład odpowiedzi
{
  "archived": false,
  "avatar": null,
  "email": "alex.rivera@example.com",
  "id": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "name": "Alex Rivera",
  "phone": "+1 415 555 0188",
  "role": "Administrator",
  "title": "Head of Operations"
}
DELETE

Delete a user

Permanently removes a user and their associated workspace data after server-side validations pass.

Status odpowiedzi: 200Identyfikator operacji: delete-users-userId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}
/users/{userId}/preferences

User preferences

Read or update personal preferences for one user.

Parametry ścieżki

  • userId: The user identifier.
GET

Get user preferences

Returns the preference document for the user. Users can only read their own preferences.

Status odpowiedzi: 200Identyfikator operacji: get-users-userId-preferences
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/preferences' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "dateTimeFormat": {
    "clock24Hour": true,
    "numeric": true,
    "showSeconds": false
  },
  "desktop": {
    "startTrackingOnStartup": false,
    "stopTrackingOnShutdown": true
  },
  "durationFormat": {
    "compact": false,
    "mode": "HOURS_MINUTES",
    "showSeconds": false
  },
  "locale": "en-US",
  "notifications": {
    "activityCreated": {
      "dashboard": true,
      "email": false,
      "popup": true
    },
    "monthlyGoalReached": {
      "dashboard": true,
      "email": true,
      "popup": true
    }
  },
  "timeZone": "Europe/Warsaw"
}
PUT

Update user preferences

Updates the user preference document with locale, formatting, desktop, notification, or time-zone changes.

Status odpowiedzi: 200Identyfikator operacji: put-users-userId-preferences
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/preferences' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "locale": "pl-PL",
  "notifications": {
    "monthlyGoalReached": {
      "dashboard": true,
      "email": true,
      "popup": false
    }
  },
  "timeZone": "Europe/Warsaw"
}'
Przykład ciała żądania
{
  "locale": "pl-PL",
  "notifications": {
    "monthlyGoalReached": {
      "dashboard": true,
      "email": true,
      "popup": false
    }
  },
  "timeZone": "Europe/Warsaw"
}
Przykład odpowiedzi
{
  "dateTimeFormat": {
    "clock24Hour": true,
    "numeric": true,
    "showSeconds": false
  },
  "desktop": {
    "startTrackingOnStartup": false,
    "stopTrackingOnShutdown": true
  },
  "durationFormat": {
    "compact": false,
    "mode": "HOURS_MINUTES",
    "showSeconds": false
  },
  "locale": "pl-PL",
  "notifications": {
    "activityCreated": {
      "dashboard": true,
      "email": false,
      "popup": true
    },
    "monthlyGoalReached": {
      "dashboard": true,
      "email": true,
      "popup": true
    }
  },
  "timeZone": "Europe/Warsaw"
}
/users/{userId}/rates/cost

User cost rates

List or create cost-rate windows for one user.

Parametry ścieżki

  • userId: The user identifier.
GET

List user cost rates

Returns an ID-keyed map of cost rates for the user.

Status odpowiedzi: 200Identyfikator operacji: get-users-userId-rates-cost
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/rates/cost' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334": {
    "currency": "USD",
    "from": "2026-07-01T00:00:00.000Z",
    "id": "7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334",
    "taxRate": 0,
    "to": "2026-12-31T23:59:59.000Z",
    "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
    "value": 65
  }
}
POST

Create a user cost rate

Creates a dated cost-rate window for the user.

Status odpowiedzi: 200Identyfikator operacji: post-users-userId-rates-cost
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/rates/cost' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 65
}'
Przykład ciała żądania
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 65
}
Przykład odpowiedzi
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00.000Z",
  "id": "7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "value": 65
}
/users/{userId}/rates/cost/{costId}

Single user cost rate

Read, update, or delete one cost-rate window.

Parametry ścieżki

  • userId: The user identifier.
  • costId: The cost rate identifier.
GET

Get a user cost rate

Returns one user cost-rate record.

Status odpowiedzi: 200Identyfikator operacji: get-users-userId-rates-cost-costId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/rates/cost/7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00.000Z",
  "id": "7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "value": 65
}
PUT

Update a user cost rate

Updates one user cost-rate window.

Status odpowiedzi: 200Identyfikator operacji: put-users-userId-rates-cost-costId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/rates/cost/7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 72
}'
Przykład ciała żądania
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00+02:00",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59+01:00",
  "value": 72
}
Przykład odpowiedzi
{
  "currency": "USD",
  "from": "2026-07-01T00:00:00.000Z",
  "id": "7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334",
  "taxRate": 0,
  "to": "2026-12-31T23:59:59.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "value": 72
}
DELETE

Delete a user cost rate

Deletes one user cost-rate record.

Status odpowiedzi: 200Identyfikator operacji: delete-users-userId-rates-cost-costId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/users/2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d/rates/cost/7bc0f6d1-d6a8-4718-8e64-b3ddcfe35334' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}

Reports

Saved report definitions for dashboards, billing, and exports.

/reports

Report collection

List saved reports or create a new report definition.

GET

List reports

Returns an ID-keyed map of saved reports.

Status odpowiedzi: 200Identyfikator operacji: get-reports
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/reports' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01": {
    "dimensions": [
      "project"
    ],
    "end": "2026-07-31T21:59:59.000Z",
    "filters": [],
    "hideEmptyRows": true,
    "id": "6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01",
    "metrics": [
      "time",
      "billable"
    ],
    "name": "July project summary",
    "period": "custom",
    "pinned": true,
    "selectedProjectMembers": null,
    "selectedProjects": [
      "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
      "58f5aa89-aed2-4a67-8808-d85ef4034f42"
    ],
    "showArchivedMembers": false,
    "showArchivedProjects": false,
    "start": "2026-06-30T22:00:00.000Z",
    "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
  }
}
POST

Create a report

Creates a saved report configuration for the current user.

Status odpowiedzi: 200Identyfikator operacji: post-reports
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/reports' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T23:59:59+02:00",
  "filters": [],
  "hideEmptyRows": true,
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-07-01T00:00:00+02:00"
}'
Przykład ciała żądania
{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T23:59:59+02:00",
  "filters": [],
  "hideEmptyRows": true,
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-07-01T00:00:00+02:00"
}
Przykład odpowiedzi
{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T21:59:59.000Z",
  "filters": [],
  "hideEmptyRows": true,
  "id": "6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01",
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "pinned": true,
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-06-30T22:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
/reports/{reportId}

Single report

Read, update, or delete a single report definition.

Parametry ścieżki

  • reportId: The report identifier.
GET

Get a report

Returns one report configuration.

Status odpowiedzi: 200Identyfikator operacji: get-reports-reportId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/reports/6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T21:59:59.000Z",
  "filters": [],
  "hideEmptyRows": true,
  "id": "6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01",
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "pinned": true,
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-06-30T22:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
PUT

Update a report

Updates one saved report.

Status odpowiedzi: 200Identyfikator operacji: put-reports-reportId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/reports/6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T23:59:59+02:00",
  "filters": [],
  "hideEmptyRows": true,
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-07-01T00:00:00+02:00",
  "pinned": true
}'
Przykład ciała żądania
{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T23:59:59+02:00",
  "filters": [],
  "hideEmptyRows": true,
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-07-01T00:00:00+02:00",
  "pinned": true
}
Przykład odpowiedzi
{
  "dimensions": [
    "project"
  ],
  "end": "2026-07-31T21:59:59.000Z",
  "filters": [],
  "hideEmptyRows": true,
  "id": "6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01",
  "metrics": [
    "time",
    "billable"
  ],
  "name": "July project summary",
  "period": "custom",
  "pinned": true,
  "selectedProjectMembers": null,
  "selectedProjects": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "showArchivedMembers": false,
  "showArchivedProjects": false,
  "start": "2026-06-30T22:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
}
DELETE

Delete a report

Deletes a saved report.

Status odpowiedzi: 200Identyfikator operacji: delete-reports-reportId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/reports/6b0dfe58-9c80-4d8d-8a9f-9e48983f4e01' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}

Geofences

Geofence definitions plus mobile enter and exit triggers.

/geofences

Geofence collection

List geofences or create a new geofence rule.

GET

List geofences

Returns an ID-keyed map of geofences.

Status odpowiedzi: 200Identyfikator operacji: get-geofences
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/geofences' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c": {
    "enterAction": "START_TRACKING_PROJECT",
    "exitAction": "STOP_TRACKING",
    "id": "cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c",
    "latitude": 52.2297,
    "longitude": 21.0122,
    "name": "Warsaw office",
    "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "radius": 120
  }
}
POST

Create a geofence

Creates a geofence with enter and exit actions.

Status odpowiedzi: 200Identyfikator operacji: post-geofences
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/geofences' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 120
}'
Przykład ciała żądania
{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 120
}
Przykład odpowiedzi
{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "id": "cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 120
}
/geofences/{geofenceId}

Single geofence

Read, update, or delete one geofence.

Parametry ścieżki

  • geofenceId: The geofence identifier.
GET

Get a geofence

Returns one geofence by ID.

Status odpowiedzi: 200Identyfikator operacji: get-geofences-geofenceId
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/geofences/cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "id": "cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 120
}
PUT

Update a geofence

Updates one geofence.

Status odpowiedzi: 200Identyfikator operacji: put-geofences-geofenceId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/geofences/cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 150
}'
Przykład ciała żądania
{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 150
}
Przykład odpowiedzi
{
  "enterAction": "START_TRACKING_PROJECT",
  "exitAction": "STOP_TRACKING",
  "id": "cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c",
  "latitude": 52.2297,
  "longitude": 21.0122,
  "name": "Warsaw office",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "radius": 150
}
DELETE

Delete a geofence

Deletes one geofence.

Status odpowiedzi: 200Identyfikator operacji: delete-geofences-geofenceId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/geofences/cf6b0bd6-dbbf-4ef5-98a7-7ae04e0eb18c' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}
/geofencing/enter

Geofence enter trigger

Signal that a device entered a geofence and let Sandtime.io run its configured enter action.

POST

Send a geofence-enter event

Processes a geofence enter event. This is mainly used by mobile clients and location automations.

Status odpowiedzi: 200Identyfikator operacji: post-geofencing-enter
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/geofencing/enter' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "latitude": 52.2297,
  "longitude": 21.0122,
  "source": "ios-geofence"
}'
Przykład ciała żądania
{
  "latitude": 52.2297,
  "longitude": 21.0122,
  "source": "ios-geofence"
}
Przykład odpowiedzi
{
  "endedAt": null,
  "name": "geofencing test",
  "projectId": null,
  "startedAt": "2026-07-03T10:00:00.000Z"
}
/geofencing/exit

Geofence exit trigger

Signal that a device left a geofence and let Sandtime.io stop pending work where configured.

POST

Send a geofence-exit event

Processes a geofence exit event and returns the pending activities that were stopped.

Status odpowiedzi: 200Identyfikator operacji: post-geofencing-exit
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/geofencing/exit' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "latitude": 52.2297,
  "longitude": 21.0122,
  "source": "ios-geofence"
}'
Przykład ciała żądania
{
  "latitude": 52.2297,
  "longitude": 21.0122,
  "source": "ios-geofence"
}
Przykład odpowiedzi
[
  {
    "billable": true,
    "endedAt": "2026-07-03T08:30:00.000Z",
    "id": "c2dbd56f-0f09-4bf8-87ae-a1c8d7e5f302",
    "name": "Implement API docs page",
    "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "startedAt": "2026-07-03T07:00:00.000Z",
    "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d"
  }
]

Requests

Approval and assignment workflows live under /requests.

/requests/projects/{projectId}/members/{memberId}/role

Create role-change request

Create a project role-change request for a member.

Parametry ścieżki

  • projectId: The project identifier.
  • memberId: The project member identifier.
POST

Create a role-change request

Creates a request to change the selected project member role.

Status odpowiedzi: 200Identyfikator operacji: post-requests-projects-projectId-members-memberId-role
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/requests/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members/3b13dd8f-bc60-4db8-a2bc-5eb16ca31a04/role' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "Administrator"
}'
Przykład ciała żądania
{
  "role": "Administrator"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED",
  "projectId": "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
  "role": "Administrator"
}
/requests/{requestId}/projects/members/role

Resolve role-change request

Resolve a role-change request by marking it RESOLVED or REJECTED.

Parametry ścieżki

  • requestId: The workflow request identifier.
PUT

Resolve a role-change request

Applies or rejects the role change for an existing request.

Status odpowiedzi: 200Identyfikator operacji: put-requests-requestId-projects-members-role
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/requests/1fbbd48d-176f-4b32-a98d-c8cf1eb291c5/projects/members/role' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "RESOLVED"
}'
Przykład ciała żądania
{
  "status": "RESOLVED"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/projects/{projectId}/members

Create project-member assignment request

Create a project-member assignment request.

Parametry ścieżki

  • projectId: The project identifier.
POST

Create a project-member assignment request

Creates a request to assign one or more users to a project.

Status odpowiedzi: 200Identyfikator operacji: post-requests-projects-projectId-members
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/requests/projects/9d58c4ce-3e6f-4d06-bf47-f70d8c4af001/members' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "userIds": [
    "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af"
  ]
}'
Przykład ciała żądania
{
  "userIds": [
    "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af"
  ]
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/{requestId}/projects/members

Resolve project-member assignment request

Resolve a project-member assignment request.

Parametry ścieżki

  • requestId: The workflow request identifier.
PUT

Resolve a project-member assignment request

Marks the request RESOLVED or REJECTED. Resolved requests assign the selected users to the project.

Status odpowiedzi: 200Identyfikator operacji: put-requests-requestId-projects-members
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/requests/1fbbd48d-176f-4b32-a98d-c8cf1eb291c5/projects/members' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "RESOLVED"
}'
Przykład ciała żądania
{
  "status": "RESOLVED"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/projects/request-assignment

Create project-assignment request

Create a request for assignment to one or more projects.

POST

Create a project-assignment request

Creates a self-service request asking administrators to assign the current user to projects.

Status odpowiedzi: 200Identyfikator operacji: post-requests-projects-request-assignment
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/requests/projects/request-assignment' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/{requestId}/projects/assign

Resolve project-assignment request

Resolve a request for assignment to projects.

Parametry ścieżki

  • requestId: The workflow request identifier.
PUT

Resolve a project-assignment request

Marks the request RESOLVED or REJECTED. Resolved requests use `projectIds` to assign the requester to projects.

Status odpowiedzi: 200Identyfikator operacji: put-requests-requestId-projects-assign
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/requests/1fbbd48d-176f-4b32-a98d-c8cf1eb291c5/projects/assign' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "projectIds": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "status": "RESOLVED"
}'
Przykład ciała żądania
{
  "projectIds": [
    "9d58c4ce-3e6f-4d06-bf47-f70d8c4af001",
    "58f5aa89-aed2-4a67-8808-d85ef4034f42"
  ],
  "status": "RESOLVED"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/{requestId}

Resolve impersonation request

Resolve an impersonation request raised elsewhere in the product.

Parametry ścieżki

  • requestId: The workflow request identifier.
PUT

Resolve an impersonation request

Marks the impersonation request RESOLVED or REJECTED. A resolved request triggers a one-time support sign-in link.

Status odpowiedzi: 200Identyfikator operacji: put-requests-requestId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/requests/1fbbd48d-176f-4b32-a98d-c8cf1eb291c5' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "RESOLVED"
}'
Przykład ciała żądania
{
  "status": "RESOLVED"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/timesheets/{year}/{week}/unlock

Create timesheet-unlock request

Create an unlock request for a locked weekly timesheet.

Parametry ścieżki

  • year: ISO week-numbering year.
  • week: ISO week number in the organization time zone.
POST

Create a timesheet-unlock request

Creates a request asking administrators to unlock one weekly timesheet.

Status odpowiedzi: 200Identyfikator operacji: post-requests-timesheets-year-week-unlock
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/requests/timesheets/2026/27/unlock' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/{requestId}/timesheets/unlock

Resolve timesheet-unlock request

Resolve a timesheet-unlock request.

Parametry ścieżki

  • requestId: The workflow request identifier.
PUT

Resolve a timesheet-unlock request

Marks the unlock request RESOLVED or REJECTED. A resolved request opens the timesheet for a temporary editing window.

Status odpowiedzi: 200Identyfikator operacji: put-requests-requestId-timesheets-unlock
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/requests/1fbbd48d-176f-4b32-a98d-c8cf1eb291c5/timesheets/unlock' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "RESOLVED"
}'
Przykład ciała żądania
{
  "status": "RESOLVED"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/timesheets/{year}/{week}/approvals

Create timesheet-approval request

Create an approval request for a weekly timesheet.

Parametry ścieżki

  • year: ISO week-numbering year.
  • week: ISO week number in the organization time zone.
POST

Create a timesheet-approval request

Creates a request asking administrators to approve a weekly timesheet.

Status odpowiedzi: 200Identyfikator operacji: post-requests-timesheets-year-week-approvals
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/requests/timesheets/2026/27/approvals' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}
/requests/{requestId}/timesheets/approvals

Resolve timesheet-approval request

Resolve a timesheet-approval request.

Parametry ścieżki

  • requestId: The workflow request identifier.
PUT

Resolve a timesheet-approval request

Marks the approval request RESOLVED or REJECTED.

Status odpowiedzi: 200Identyfikator operacji: put-requests-requestId-timesheets-approvals
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/requests/1fbbd48d-176f-4b32-a98d-c8cf1eb291c5/timesheets/approvals' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "RESOLVED"
}'
Przykład ciała żądania
{
  "status": "RESOLVED"
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T09:02:11.000Z",
  "createdBy": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "id": "1fbbd48d-176f-4b32-a98d-c8cf1eb291c5",
  "resolvedAt": "2026-07-03T09:08:45.000Z",
  "resolvedBy": "8eb3c82f-420d-4a7d-b4e5-689f6cf9c8af",
  "status": "RESOLVED"
}

Timesheets

Explicit timesheet locks, automatic lock execution, and reminder delivery.

/timesheets/auto-lock

Auto-lock runner

Run the organization auto-lock routine against the current time zone and lock settings.

PUT

Run auto-lock

Evaluates whether the next weekly lock should run and updates organization lock metadata when it does.

Status odpowiedzi: 200Identyfikator operacji: put-timesheets-auto-lock
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/timesheets/auto-lock' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "scheduled-reminder-run"
}'
Przykład ciała żądania
{
  "reason": "scheduled-reminder-run"
}
Przykład odpowiedzi
{
  "coreHours": {
    "end": "17:00",
    "start": "09:00"
  },
  "currency": "USD",
  "holidays": {
    "country": "US",
    "excluded": []
  },
  "id": "8a4affba-df59-47bd-8173-d175e76efd15",
  "lockingTimesheets": {
    "enabled": false,
    "timeZone": null,
    "week": null,
    "year": null
  },
  "name": "Acme Studio",
  "notes": "Weekly client delivery team.",
  "onboarding": {
    "assignMembers": {
      "done": true,
      "viewed": true
    },
    "inviteMembers": {
      "done": true,
      "viewed": true
    },
    "organization": {
      "done": true,
      "viewed": true
    },
    "preferences": {
      "done": false,
      "viewed": true
    },
    "projects": {
      "done": true,
      "viewed": true
    }
  },
  "plan": "free",
  "rounding": {
    "enabled": false,
    "interval": 900000,
    "mode": "NEAREST"
  },
  "timeZone": "Europe/Warsaw"
}
/timesheets/lock

Timesheet lock collection

Create a lock or temporary unlock window for one user and one ISO week.

POST

Create a timesheet lock

Creates or replaces one timesheet lock for the selected user/week combination.

Status odpowiedzi: 200Identyfikator operacji: post-timesheets-lock
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/timesheets/lock' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "unlockedTo": "2026-07-04T20:00:00+02:00",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "week": 27,
  "year": 2026
}'
Przykład ciała żądania
{
  "unlockedTo": "2026-07-04T20:00:00+02:00",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "week": 27,
  "year": 2026
}
Przykład odpowiedzi
{
  "createdAt": "2026-07-03T10:00:00.000Z",
  "id": "5c27ad51-cbb7-4f96-84c7-f19dd3750a42",
  "unlockedTo": "2026-07-04T18:00:00.000Z",
  "updatedAt": "2026-07-03T10:00:00.000Z",
  "userId": "2f9fd8a8-9f6d-4b2b-a4f4-1f1f2a7d9b9d",
  "week": 27,
  "year": 2026
}
/timesheets/lock/{lockId}

Single timesheet lock

Delete one explicit timesheet lock or unlock window.

Parametry ścieżki

  • lockId: The timesheet lock identifier.
DELETE

Delete a timesheet lock

Deletes one timesheet lock by ID.

Status odpowiedzi: 200Identyfikator operacji: delete-timesheets-lock-lockId
przykład cURL
curl -X DELETE 'https://your-organization.sandtime.io/api/timesheets/lock/5c27ad51-cbb7-4f96-84c7-f19dd3750a42' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
{}
/timesheets/reminder

Timesheet reminder runner

Trigger the reminder flow that asks users to fill timesheets before the automatic lock runs.

POST

Send timesheet reminders

Runs the reminder logic for the current organization.

Status odpowiedzi: 200Identyfikator operacji: post-timesheets-reminder
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/timesheets/reminder' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "friday-evening-check"
}'
Przykład ciała żądania
{
  "reason": "friday-evening-check"
}
Przykład odpowiedzi
null

Billing

Billing, plan changes, and checkout helpers.

/subscriptions

Subscription collection

Read the current subscription collection for the organization.

GET

List subscriptions

Returns subscription records for the current organization.

Status odpowiedzi: 200Identyfikator operacji: get-subscriptions
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/subscriptions' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
[
  {
    "id": "sub_01J1YB3TQK5K9S2H4E5T6U7V8W",
    "nextBillDate": "2026-08-01",
    "plan": "monthly",
    "quantity": 1,
    "status": "active"
  }
]
/subscriptions/{subscriptionId}

Single subscription

Update one subscription, usually to change quantity or payment state.

Parametry ścieżki

  • subscriptionId: The external subscription identifier.
PUT

Update a subscription

Updates one existing subscription. This route is limited to administrators.

Status odpowiedzi: 200Identyfikator operacji: put-subscriptions-subscriptionId
przykład cURL
curl -X PUT 'https://your-organization.sandtime.io/api/subscriptions/sub_01J1YB3TQK5K9S2H4E5T6U7V8W' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "quantity": 2
}'
Przykład ciała żądania
{
  "quantity": 2
}
Przykład odpowiedzi
{}
/checkout

Checkout

Create a checkout link for a plan change.

POST

Create a checkout link

Creates a Paddle checkout link for the selected product and quantity.

Status odpowiedzi: 200Identyfikator operacji: post-checkout
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/checkout' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "product": 123456,
  "quantity": 1
}'
Przykład ciała żądania
{
  "product": 123456,
  "quantity": 1
}
Przykład odpowiedzi
{
  "url": "https://pay.paddle.com/pay/cpl_example"
}
/billing-history

Billing history

Read the billing transaction history for the current organization.

GET

List billing history

Returns the current billing history from the payment provider.

Status odpowiedzi: 200Identyfikator operacji: get-billing-history
przykład cURL
curl -X GET 'https://your-organization.sandtime.io/api/billing-history' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json"
Przykład odpowiedzi
[
  {
    "amount": 4900,
    "currency": "USD",
    "id": "txn_01J1YB6A0M2K8H5V7P9R4S3T2Q",
    "paidAt": "2026-07-01T08:10:00.000Z",
    "status": "paid"
  }
]
/receipt

Receipt upload

Upload an App Store receipt for validation.

POST

Upload a receipt

Submits a base64-encoded receipt payload to the billing backend.

Status odpowiedzi: 200Identyfikator operacji: post-receipt
przykład cURL
curl -X POST 'https://your-organization.sandtime.io/api/receipt' \
  -H "Authorization: Bearer YOUR_SANDTIME_ACCESS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "receiptBase64": "MIIT9QYJKoZIhvcNAQcCoIIT5jCCE+ICAQExCzAJBgUr..."
}'
Przykład ciała żądania
{
  "receiptBase64": "MIIT9QYJKoZIhvcNAQcCoIIT5jCCE+ICAQExCzAJBgUr..."
}
Przykład odpowiedzi
{
  "ok": true
}