Skip to content
Docs

Availability

A host's availability is a set of weekly rules plus date overrides, all in the host's timezone. Minutes are counted from midnight (540 is 09:00), and weekday is 0 for Sunday through 6 for Saturday. A rule must end after it starts and rules on the same weekday cannot overlap (overlapping_rules).

An override replaces the rules for one date. Give it a start and end minute to open different hours, or set both to null to block the whole day. All endpoints need an API key.

GET /availability

Weekly rules and date overrides. Auth: API key.

Response 200

Body

FieldTypeRequiredDefault / limits
timezonestringyes-
rulesobject[]yes-
rules[].weekdayintegeryes0–6
rules[].startMinuteintegeryes0–1440
rules[].endMinuteintegeryes0–1440
overridesobject[]yes-
overrides[].datestring (date)yes-
overrides[].startMinuteinteger | nullyes-
overrides[].endMinuteinteger | nullyes-
overrides[].idstring (uuid)yes-

Errors: unauthorized

curl -X GET "https://devalender.com/api/availability" \
  -H "Authorization: Bearer dvl_..."

PUT /availability/rules

Replace the weekly rules. Auth: API key.

Request body

FieldTypeRequiredDefault / limits
rulesobject[]yesmax 100 items
rules[].weekdayintegeryes0–6
rules[].startMinuteintegeryes0–1440
rules[].endMinuteintegeryes0–1440

Response 200

Body

FieldTypeRequiredDefault / limits
rulesobject[]yes-
rules[].weekdayintegeryes0–6
rules[].startMinuteintegeryes0–1440
rules[].endMinuteintegeryes0–1440

Errors: invalid_request, overlapping_rules, unauthorized

curl -X PUT "https://devalender.com/api/availability/rules" \
  -H "Authorization: Bearer dvl_..." \
  -H "Content-Type: application/json" \
  -d '{"rules":[{"weekday":1,"startMinute":540,"endMinute":1020}]}'

POST /availability/overrides

Add a date override. Auth: API key.

Request body

FieldTypeRequiredDefault / limits
datestring (date)yes-
startMinuteinteger | nullyes-
endMinuteinteger | nullyes-

Response 201

Body

FieldTypeRequiredDefault / limits
datestring (date)yes-
startMinuteinteger | nullyes-
endMinuteinteger | nullyes-
idstring (uuid)yes-

Errors: invalid_request, unauthorized

curl -X POST "https://devalender.com/api/availability/overrides" \
  -H "Authorization: Bearer dvl_..." \
  -H "Content-Type: application/json" \
  -d '{"date":"2030-01-07","startMinute":null,"endMinute":null}'

DELETE /availability/overrides/:id

Remove a date override. Auth: API key.

Path parameters

FieldTypeRequiredDefault / limits
idstringyes-

Response 204

No body.

Errors: unauthorized, not_found

curl -X DELETE "https://devalender.com/api/availability/overrides/<id>" \
  -H "Authorization: Bearer dvl_..."