Get times available for appointment booking

GET

/api/partners/v1/community/{community_id}/appointments/available-times/

Returns a list of times that are avaialble for a booking on the given date. Any of these times should be a valid value for start field when booking an appointment using the booking end-point.

Authorizations

• BasicAuth
• BearerAuth

Parameters

Path Parameters

community_id

required

string

The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that ID to Funnel.

Examples

Funnel Community ID

The raw integer Funnel ID of a community.

1234

Funnel Community Syndication ID

The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.

P1234-567

Partner ID

The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.

partner-id:apts123

Query Parameters

date

required

string

Date in the format YYYY-MM-DD

tour_type

string

default: guided

Allowed values: guided self-guided video

Appointment type

Responses

200

Success

object

available_times

Array<string>

400

401

403

We were unable to authenticate your request with the provided API key.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.

404

A community with this ID does not exist.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.