RoadOps Developer Docs

List days

GET/v1/teams/{teamId}/days

Lists day records for a team.

Required scopes: day:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`query.startDate`	`string:date` Optional inclusive start date filter in YYYY-MM-DD format.
`query.endDate`	`string:date` Optional inclusive end date filter in YYYY-MM-DD format.
`query.includeHistorical`	`boolean` Set to true to include historical days when no startDate or endDate is provided. Defaults to false.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].id`	`string:uuid` Day identifier.
`data[].orgId`	`string:uuid` Team identifier.
`data[].name`	`string` Day display name.
`data[].date`	`string` Calendar date for the day in YYYY-MM-DD format.
`data[].timezone`	`object` IANA timezone for the day.
`data[].location`	`string` Optional city, venue, or location label.
`data[].color`	`string` Hex color reference for the day label, formatted as #RRGGBB.
`data[].visibility`	`object` Optional visibility rules for the day.
`data[].visibility.groupIds`	`string:uuid[]`
`data[].visibility.userIds`	`string:uuid[]`
`data[].latitude`	`number` Latitude in decimal degrees.
`data[].longitude`	`number` Longitude in decimal degrees.
`data[].isDeleted`	`boolean` Soft-delete flag.
`data[].version`	`integer` Current day aggregate version.
`data[].cursor`	`integer` Latest event-ledger cursor projected into this day record.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.
`meta`	`object`
`meta.cursor`	`number \| null` Highest record cursor represented by this response.

Create a day

POST/v1/teams/{teamId}/days

Accepts a command to create a day.

Required scopes: day:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`name`required	`string` Day display name.
`date`required	`string` Calendar date for the day in YYYY-MM-DD format.
`timezone`required	`object` IANA timezone for the day.
`location`	`string` Optional city, venue, or location label.
`color`	`string` Hex color reference for the day label, formatted as #RRGGBB.
`visibility`	`object` Optional visibility rules for the day.
`visibility.groupIds`	`string:uuid[]`
`visibility.userIds`	`string:uuid[]`
`latitude`	`number` Latitude in decimal degrees.
`longitude`	`number` Longitude in decimal degrees.
`id`	`string:uuid` Optional caller-supplied day ID. RoadOps generates one when omitted.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Retrieve a day

GET/v1/teams/{teamId}/days/{dayId}

Returns a single day record by ID.

Required scopes: day:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.

Response 200

`data`	`object`
`data.id`	`string:uuid` Day identifier.
`data.orgId`	`string:uuid` Team identifier.
`data.name`	`string` Day display name.
`data.date`	`string` Calendar date for the day in YYYY-MM-DD format.
`data.timezone`	`object` IANA timezone for the day.
`data.location`	`string` Optional city, venue, or location label.
`data.color`	`string` Hex color reference for the day label, formatted as #RRGGBB.
`data.visibility`	`object` Optional visibility rules for the day.
`data.visibility.groupIds`	`string:uuid[]`
`data.visibility.userIds`	`string:uuid[]`
`data.latitude`	`number` Latitude in decimal degrees.
`data.longitude`	`number` Longitude in decimal degrees.
`data.isDeleted`	`boolean` Soft-delete flag.
`data.version`	`integer` Current day aggregate version.
`data.cursor`	`integer` Latest event-ledger cursor projected into this day record.
`meta`	`object`
`meta.cursor`	`integer` Highest record cursor represented by this response.

Update a day

PATCH/v1/teams/{teamId}/days/{dayId}

Accepts a command to update a day.

Required scopes: day:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`expectedVersion`	`integer` Optional aggregate version guard.
`updates`required	`object`
`updates.name`	`string` Updated day display name.
`updates.timezone`	`object` Updated IANA timezone identifier.
`updates.location`	`string \| null` Updated city, venue, or location label, or null to clear it.
`updates.color`	`string \| null` Updated hex color reference for the day label, or null to clear it.
`updates.visibility`	`object \| null` Updated visibility rules or null to clear them.
`updates.visibility.groupIds`	`string:uuid[]`
`updates.visibility.userIds`	`string:uuid[]`
`updates.latitude`	`number \| null` Updated latitude in decimal degrees, or null to clear it.
`updates.longitude`	`number \| null` Updated longitude in decimal degrees, or null to clear it.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Delete a day

DELETE/v1/teams/{teamId}/days/{dayId}

Accepts a command to delete a day.

Required scopes: day:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Days

List days

Parameters

Response 200

Create a day

Parameters

Request body (application/json)

Response 202

Retrieve a day

Parameters

Response 200

Update a day

Parameters

Request body (application/json)

Response 202

Delete a day

Parameters

Response 202