Get community details
GET
/api/partners/v1/community/{community_id}/
Return details about a community
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “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.
1234Funnel Community Syndication ID
The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.
P1234-567Partner ID
The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.
partner-id:apts123Responses
Section titled “ Responses ”Success
object
id
integer
7 name
string
The Soho Muse street_address
string
550 Memory Lane city
string
New York state
string
NY postal_code
string
11231 special_offers
string
One month free on immediate move-in. hours_of_operation
object
monday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
tuesday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
wednesday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
thursday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
friday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
saturday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
sunday
object
open_at
string
09:00:00 close_at
string
18:00:00 is_closed
boolean
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.A community with this ID does not exist.
object
error_type
string
CommunityNotFound message
string
Could not find community with corresponding ID.