API Reference
Timesheet Period Templates API
API reference for reading timesheet period templates via the Dime.Sheets public API.
Timesheet Period Templates API
The Timesheet Period Templates public API provides read-only access to period cadence definitions. Templates define how time entries are bucketed into periods (weekly, bi-weekly, monthly, or custom).
List templates
GET /api/v1/timesheet-period-templatesReturns all active period templates in the tenant.
curl "https://app.dimesheets.com/api/v1/timesheet-period-templates" \
-H "X-API-KEY: {your-api-key}"Example response
[
{
"id": 1,
"externalId": "tpl-weekly",
"tenantId": "tenant-abc",
"name": "Standard Weekly",
"cadence": 0,
"anchorDate": "2026-01-05T00:00:00Z",
"namingPattern": "{Year}-W{Week}",
"isActive": true,
"excludeWeekends": true,
"submissionReminderDayOfWeek": 5,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]Get a template
GET /api/v1/timesheet-period-templates/{externalId}Returns the template matching the given external ID, or 404 Not Found.
TimesheetPeriodTemplate model
| Field | Type | Description |
|---|---|---|
id | int | Internal ID |
externalId | string | Stable external identifier |
tenantId | string | Tenant ID |
name | string | Template name |
cadence | int | Period cadence: 0 Weekly, 1 BiWeekly, 2 Monthly, 3 Custom |
anchorDate | datetime | Anchor date for cadence calculation |
namingPattern | string | Naming pattern with tokens: {Year}, {Month}, {MonthName}, {Week}, {StartDate}, {EndDate} |
isActive | boolean | Whether the template is active |
excludeWeekends | boolean | Whether weekends are excluded from period calculations |
submissionReminderDayOfWeek | int? | Day of week for submission reminders (0=Sunday, 5=Friday) |
createdAt | datetime | Creation timestamp |
updatedAt | datetime | Last update timestamp |