Get times available for appointment booking

Returns a list of times that are available for a booking. Any of these times should be a valid value for start field when booking an appointment using the booking end-point. You must supply either date (a single day) or from_date (a date range, with optional to_date) — they cannot be combined, and this is a distinct 7-day cap unrelated to the Customer API's 60-day limit on its equivalent endpoint.

GET

/api/partners/v1/community/:community_id/appointments/available-times/

Request

Example requestGET

curl -X GET \
    -H "Authorization: Bearer YOUR_API_KEY" \
    "https://api.funnelleasing.com/api/partners/v1/community/1234/appointments/available-times/"

Response

Example responseJSON200 · application/json

{
  "available_times": [
    "2020-01-07T09:00:00"
  ],
  "duration": 30,
  "timezone": "America/New_York"
}

⚠️

format=realpage returns a completely different shape

Passing ?format=realpage replaces the response above with a RealPage-specific shape — not an extension of it, a different structure entirely:

{
  "data": [
    {
      "startTime": "2020-01-07T09:00:00",
      "endTime": "2020-01-07T09:30:00",
      "timezone": "-0500",
      "appointmentType": ["guided"]
    }
  ],
  "errors": null
}

Two details worth noting: errors is always null here — this key is part of the RealPage envelope only; the endpoint's actual error responses, listed below, use the standard shape regardless of format — and timezone here is a UTC offset string like "-0500" — not the IANA name (e.g. "America/New_York") used in the default response above, even though both use the same field name. appointmentType is ["self-guided"] for self-guided tours, or ["guided"] (with "online" appended when video tours are enabled) otherwise.

Errors

Errors specific to this endpoint

Date Required (400)

Returned when neither date nor from_date is supplied.

Error responseJSON400 · application/json

{
"error_type": "ValidationError",
"errors": { "date": ["Date required."] }
}

Date and Range Combined (400)

Returned when date is supplied together with from_date or to_date.

Error responseJSON400 · application/json

{
"error_type": "ValidationError",
"errors": { "date": ["Can't specify `date` and from_date/to_date at the same time."] }
}

to_date Before from_date (400)

Returned when to_date is earlier than from_date.

Error responseJSON400 · application/json

{
"error_type": "ValidationError",
"errors": { "to_date": ["to_date can't precede from_date."] }
}

Range Exceeds 7 Days (400)

Returned when the requested range exceeds 7 days — see to_date above for the exact rule.

Error responseJSON400 · application/json

{
"error_type": "ValidationError",
"errors": { "to_date": ["Date range can't be more than 7 days."] }
}

Community Not Set Up for Tour Scheduling (400)

Returned when the community has no employee group configured.

Error responseJSON400 · application/json

{
"error_type": "CommunitySchedulingInactive",
"message": "Community does not have tour scheduling enabled."
}

Tour Type Not Enabled (400)

Returned when the requested tour_type isn't enabled for this community's employee group. The message names the tour type you requested — for example, guided, self-guided, or video.

Error responseJSON400 · application/json

{
"error_type": "CommunitySchedulingInactive",
"message": "Community does not have guided tour scheduling enabled."
}