List funnel renter IDs
Return a list of funnel_renter_ids (often referred to as client id or prospect id), from a renter household by xid
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”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:apts123Query Parameters
Section titled “Query Parameters ”The external renter household identifier.
The PMS identifier to match the external renter_household_xid with. Valid values are [‘REALPAGE_ONESITE’, ‘YARDI’, ‘ENTRATA’].
Responses
Section titled “ Responses ”Success
object
We were unable to authenticate your request with the provided API key.
object
CommunityNotFoundCould not find community with corresponding ID.A community with this ID does not exist.
object
CommunityNotFoundCould not find community with corresponding ID.