Get all appointments for a community.

GET

/api/partners/v1/community/{community_id}/appointments/booked/

Returns a paginated list of booked appointments ordered by appointment ID.

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

page

integer

default: 1 >= 1

Page number to return

per_page

integer

default: 50 >= 1 <= 50

Number of items per page.

date

string format: date

Specific date for which to fetch appointments. Format: YYYY-MM-DD

from_date

string format: date

Start of a date range. Required if using to_date. When using date range parameters, the range cannot exceed 365 days between from_date and to_date. Format: YYYY-MM-DD

to_date

string format: date

End of a date range. Required if using from_date. When using date range parameters, the range cannot exceed 365 days between from_date and to_date. Format: YYYY-MM-DD

email

string

Email address of a prospect to match by contact info

phone

string

Phone number of a prospect to match by contact info. Should begin with + country code

Responses

200

Success

object

data

Array<object>

object

id

Appointment ID

integer

123

date

Date of appointment

string format: date

2023-10-05

time

Appointment time

string

09:55

client

object

id

Client guestcard ID

integer

1

first_name

Primary person firstname

string

John

last_name

Primary person lastname

string

Doe

email

Primary person email

string

johndoe@sample.email

phone

Primary person phone number

string

+15551234567

origin_source

Origin source of the client

string

Online Leasing

agent

object

name

Name of appointment’s assigned agent in Funnel or else Unassigned; may be null

string

Jane Doe

email

Email of the assigned agent’s Funnel user; null if unassigned

string

janedoe@sample.email

tour_type

string

Allowed values: Guided Self-Guided Pre-Recorded Resident Appointment

Self-Guided

status

Current status of the appointment

string

Allowed values: Tentative Not Confirmed Confirmed Cancelled Completed No Show

Completed

page

Current page number

integer

1

total_pages

Total number of pages available

integer

1

total_items

Total number of matching appointments

integer

1

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

No booked appointments could be found for the provided community and query params.

object

data

string

No booked appointments found