API reference · v1
Expand an RRULE
Expand an iCalendar (RFC 5545) recurrence rule into occurrences in an IANA time zone. Supports FREQ=YEARLY/MONTHLY/WEEKLY/DAILY with INTERVAL, COUNT, UNTIL, BYMONTH, BYYEARDAY, BYMONTHDAY, BYDAY with ordinals (1MO, -1FR), BYHOUR, BYMINUTE, BYSECOND, BYSETPOS and WKST. Follows RFC 5545 where libraries disagree: invalid dates such as the 31st of a short month are skipped, BYDAY limits DAILY and WEEKLY, wall-clock times that DST skips move forward by the gap and repeated ones use the first occurrence (adjusted says which). HOURLY/MINUTELY/SECONDLY and BYWEEKNO are not supported. Requires a credential with tools.run; every accepted call consumes one monthly unit, including business 4xx/5xx.
/v1/run/rrule/occurrencesAccess requirements
Health, metadata, changelog and waitlist routes are public. Catalog reads (GET /v1/tools, /v1/tools/{id}, /v1/colors/*) and POST /v1/tools/query require a tools.read credential; POST /v1/run/* requires tools.run. There is no anonymous access to these routes: send an API key (Bearer OR X-API-Key) from your server, or use the HttpOnly main-site session plus workspace selection and same-origin Origin. Never combine credentials. Every admitted call is metered. Ingress and workspace/actor minute/month limits are separate; waitlist has its own policy.
Implemented interfaces and development screens do not imply public production availability, paid access or a completed payment integration. Confirm access with Birdor before connecting an application. No paid Pro service, activation or cross-device sync is currently delivered. We are validating one repeatable task before building a paid offer.
Parameters
| Field | Description |
|---|---|
AuthorizationstringOptional | Bearer API key with tools.run; alternatively X-API-Key. One of the credentials is required. |
X-API-KeystringOptional | Alternative to Authorization; never send both. |
X-Birdor-Workspace-IDstringOptional | Required with the site session; optional and matching with an API key. |
X-Birdor-Project-IDstringOptional | Optional owned project; a project-bound key cannot select another project. |
Request body
Send JSON with Content-Type: application/json.
| Field | Description |
|---|---|
rrulestringRequired | RRULE value such as FREQ=MONTHLY;BYDAY=-1FR;COUNT=12 (an RRULE: prefix is fine), or pasted iCalendar lines DTSTART;TZID=…:…\nRRULE:… . |
dtstartstringOptional | First occurrence: local wall time YYYY-MM-DDTHH:MM[:SS] (or a date) in timeZone, or an instant with Z/offset. Required unless rrule contains a DTSTART line. |
timeZonestringOptional | IANA time zone the rule repeats in (wall-clock times stay fixed across DST); default UTC, or the DTSTART TZID. |
limitintegerOptional | Maximum occurrences to return, 1–500; default 20. |
afterstringOptional | RFC 3339 instant; only occurrences strictly after it are returned (COUNT still counts from DTSTART). |
includeDtstartbooleanOptional | RFC 5545 counts DTSTART as the first occurrence even when the rule does not match it (default true). false matches rrule.js/python-dateutil behaviour. |
Request example
curl --request POST "$BIRDOR_API_BASE_URL/v1/run/rrule/occurrences" \
--header "Accept: application/json" \
--header "Authorization: Bearer $BIRDOR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"rrule": "FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1;COUNT=3",
"dtstart": "2026-10-30T17:00",
"timeZone": "America/New_York"
}'Examples are copied only; this page does not send API requests.
Responses
Illustrative response. Values vary by environment and time.
200Success
{
"ok": true,
"data": {
"rrule": "FREQ=MONTHLY;COUNT=3;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1",
"timeZone": "America/New_York",
"dtstart": {
"utc": "2026-10-30T21:00:00.000Z",
"local": "2026-10-30T17:00:00-04:00"
},
"dtstartMatchesRule": true,
"occurrences": [
{
"utc": "2026-10-30T21:00:00.000Z",
"local": "2026-10-30T17:00:00-04:00",
"adjusted": null
},
{
"utc": "2026-11-30T22:00:00.000Z",
"local": "2026-11-30T17:00:00-05:00",
"adjusted": null
},
{
"utc": "2026-12-31T22:00:00.000Z",
"local": "2026-12-31T17:00:00-05:00",
"adjusted": null
}
],
"status": "complete"
},
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}400Invalid JSON, schema validation failure (field paths/codes only, never input values) or ambiguous credentials
{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}401Missing, expired, rotated, revoked or invalid credential; there is no anonymous access
{
"ok": false,
"code": "UNAUTHENTICATED",
"message": "API access denied",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}403Key lacks tools.run, or workspace/project/member policy or site Origin denied
{
"ok": false,
"code": "FORBIDDEN",
"message": "API access denied",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}405Only POST is supported; rejected before admission
{
"ok": false,
"code": "METHOD_NOT_ALLOWED",
"message": "Method not allowed",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}408Body read exceeds five seconds; before admission
{
"ok": false,
"code": "REQUEST_TIMEOUT",
"message": "Request body timeout or aborted",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}413Body exceeds 4096 bytes; before admission
{
"ok": false,
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body too large",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}415Content-Type must be application/json; before admission
{
"ok": false,
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "JSON content type required",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}429Ingress, workspace/actor minute or monthly quota exceeded; inspect code and Retry-After
{
"ok": false,
"code": "QUOTA_EXCEEDED",
"message": "API request limit exceeded",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}500Unexpected operation failure; details are never echoed
{
"ok": false,
"code": "OPERATION_FAILED",
"message": "Operation failed",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}503Authentication/metering dependency unavailable
{
"ok": false,
"code": "API_GATEWAY_UNAVAILABLE",
"message": "API access denied",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}422INVALID_RRULE: The rule cannot be parsed or uses an unsupported part; details.reason explains why; INVALID_TIME_ZONE: timeZone or DTSTART TZID is not a supported IANA time zone; INVALID_DTSTART: dtstart is missing, invalid, given twice (field and DTSTART line) or outside years 1–9999
{
"ok": false,
"code": "INVALID_RRULE",
"message": "The rule cannot be parsed or uses an unsupported part; details.reason explains why",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}Example response fields
Fields shown in this example; optional fields can be omitted. Array rows describe the first example element.
- okboolean
- Application success flag.
- dataobject
- Endpoint-specific result.
- data.rrulestring
- Endpoint-specific example value.
- data.timeZonestring
- IANA time zone used for wall times.
- data.dtstartobject
- Endpoint-specific example value.
- data.dtstart.utcstring
- Run instant in UTC (ISO 8601).
- data.dtstart.localstring
- Run wall time with the zone offset at that instant (RFC 3339).
- data.dtstartMatchesRuleboolean
- Endpoint-specific example value.
- data.occurrencesarray
- Endpoint-specific example value.
- data.occurrences[].utcstring
- Run instant in UTC (ISO 8601).
- data.occurrences[].localstring
- Run wall time with the zone offset at that instant (RFC 3339).
- data.occurrences[].adjustednull
- Endpoint-specific example value.
- data.statusstring
- Operation result.
- request_idstring
- Origin-response identifier matching X-Request-ID; a shared HTTP cache may replay the original trace.
- timestampstring
- Response creation timestamp.