Search the docs

Find a page, a section, or an endpoint.

Sign inStart for free

Free time

Every free time endpoint, generated from the API's own schemas.

When several addresses are all free

get/api/v1/calendar/free-time

The stretches in a window when every address in `identity_ids` is free, at least `duration_minutes` long. Busy is a timed event that is not cancelled and that the address has not declined; tentative counts as busy, all-day events do not. `day_start` and `day_end` limit it to working hours, read in `timezone` (the first address’s calendar zone by default), and each slot carries its wall times in that zone too. Needs `read` on every address. It books nothing.

Parameters

  • identity_idsstringrequired
  • afterdate-time
  • beforedate-time
  • duration_minutesnumber
  • day_startstring
  • day_endstring
  • timezonestring
  • skip_weekendsenum

    true · false

Responses

  • 200The free time.
  • 400The request is not valid. `error.field` names the input at fault when there is one.
  • 401No API key, or one that is not valid.
  • 403Refused. `error.code` says why: `forbidden` when this key may not do this or the account is on hold, `abuse_blocked` when a limit says no.
  • 404No such resource, or one this key cannot reach. The two answer the same, so treat a 404 as “not available to you” rather than “does not exist”.
  • 409It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
  • 500Something went wrong on our side. Retry; if it keeps happening, tell us.
  • 503Something this needs is not answering right now. Retry in a moment.
bash
curl https://pidgeon.ai/api/v1/calendar/free-time \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json