API Reference
API Reference
REST API for Dime.Sheets -- authentication and resource guides for integrations.
API Reference
Use the public REST API under /api/v1 for server-to-server integrations. Authenticate with an API key via the X-API-KEY header. For interactive exploration, open /docs (Scalar) on your deployment when the app is running.
Base URL
https://app.dimesheets.com/api/v1Endpoint groups
| Tag | Endpoints | Description |
|---|---|---|
| Projects | GET/POST /projects, GET/PUT/DELETE /projects/{externalId} | Project CRUD |
| Tasks | GET/POST /tasks, GET/PUT/DELETE /tasks/{externalId} | Task CRUD |
| Clients | GET /clients, GET /clients/{externalId} | Client read-only |
| Time Entries | GET/POST /time-entries | List and create time entries |
| Timesheets | GET /timesheets/{id} | Retrieve a timesheet by ID |
| Reports | GET /reports, GET /reports/utilization, GET /reports/budget | Time and utilization reports |
| Timesheet Period Templates | GET /timesheet-period-templates, GET /.../{externalId} | Period cadence definitions |
| Timesheet Periods | GET /timesheet-periods, GET /.../{externalId} | Concrete period date ranges |
| Integration | POST /integration/projects, .../tasks, .../employees | Bulk upsert for B2B sync |
All paths are prefixed with /api/v1.
Error handling
The API returns RFC 9457 Problem Details for errors:
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": 404,
"detail": "Project with external ID 'abc' was not found."
}Common status codes:
| Code | Meaning |
|---|---|
200 | Success |
201 | Created |
204 | No Content (successful delete) |
400 | Validation error |
401 | Missing or invalid API key |
403 | Insufficient permissions |
404 | Resource not found |
409 | Conflict (e.g., closed period) |
Guides
- Authentication -- API key setup and usage
- Projects -- Project CRUD
- Tasks -- Task CRUD
- Clients -- Client read-only access
- Time Entries -- List and create time entries
- Timesheets -- Retrieve timesheet aggregates
- Reports -- Time, utilization, and budget reports
- Timesheet Period Templates -- Period cadence definitions
- Timesheet Periods -- Concrete period date ranges
- Integration -- Bulk upsert for B2B sync