LogoRecal

Get User Availability

Get the free-busy of a user across all their calendars

GET
/v1/users/{userId}/calendar/free-busy

Authorization

AuthorizationRequiredBearer <token>

The Recal API token

In: header

Path Parameters

userIdRequiredstring

Query Parameters

minDateRequiredDate | string | number
maxDateRequiredDate | string | number
timeZonestring
Default: "UTC"
providerstring | array<unknown>

Response Body

TypeScript Definitions

Use the response body type in TypeScript.

responseRequiredarray<object>

TypeScript Definitions

Use the response body type in TypeScript.

responseRequiredstring

TypeScript Definitions

Use the response body type in TypeScript.

responseRequiredstring
curl -X GET "https://api.recal.dev/v1/users/string/calendar/free-busy?minDate=%5Bobject+Object%5D&maxDate=%5Bobject+Object%5D&timeZone=UTC&provider=google" \
  -H "Authorization: Bearer <token>"
fetch("https://api.recal.dev/v1/users/string/calendar/free-busy?minDate=%5Bobject+Object%5D&maxDate=%5Bobject+Object%5D&timeZone=UTC&provider=google", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.recal.dev/v1/users/string/calendar/free-busy?minDate=%5Bobject+Object%5D&maxDate=%5Bobject+Object%5D&timeZone=UTC&provider=google"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.recal.dev/v1/users/string/calendar/free-busy?minDate=%5Bobject+Object%5D&maxDate=%5Bobject+Object%5D&timeZone=UTC&provider=google"

response = requests.request("GET", url, headers = {
  "Authorization": "Bearer <token>"
})

print(response.text)
[
  {
    "start": "1970-01-01T01:00:00.000+01:00",
    "end": "1970-01-01T01:00:00.000+01:00"
  }
]
"User has not the needed calendars connected"
"Organization not found"