Tasks | RetailHardHat REST API docs

Supported operations

Method	Path	Description
GET	`/api/v1/tasks`	List all tasks
GET	`/api/v1/tasks/:id`	Get a task by ID
POST	`/api/v1/tasks`	Create a new task
PATCH	`/api/v1/tasks/:id`	Update a task
DELETE	`/api/v1/tasks/:id`	Delete a task

Example request

Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.

curl --request GET "/api/v1/tasks" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

Field	Type	Model requirement	Description
`id`	`string`	Optional	Unique identifier (auto-generated)
`siteId`	`uuid`	Required	site Id Related resource: `sites`
`phaseId`	`uuid`	Optional	phase Id Related resource: `phases`
`parentId`	`uuid`	Optional	parent Id Related resource: `tasks`
`title`	`string`	Required	title
`description`	`string`	Optional	description
`type`	`enum`	Optional	type Values: `task`, `inspection`, `milestone`, `checklist`, `phase`
`team`	`enum`	Optional	team Values: `construction`, `real_estate`, `finance`, `operations`, `legal`, `marketing`, `hr`, `it`, `general`
`assignee`	`string`	Optional	assignee
`assignedToUserId`	`uuid`	Optional	assigned To User Id Related resource: `users`
`priority`	`enum`	Optional	priority Values: `low`, `medium`, `high`
`status`	`enum`	Optional	status Values: `todo`, `in_progress`, `review`, `completed`, `cancelled`
`isUrgent`	`boolean`	Optional	is Urgent
`estimatedHours`	`number`	Optional	estimated Hours
`tags`	`array`	Optional	tags
`dueDate`	`datetime`	Optional	due Date
`startDate`	`datetime`	Optional	start Date
`dueDaysBeforeOpening`	`number`	Optional	due Days Before Opening
`startDaysBeforeOpening`	`number`	Optional	start Days Before Opening
`templateTaskId`	`uuid`	Optional	template Task Id
`completedAt`	`datetime`	Optional	completed At
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)