List funnel renter IDs

GET

/api/partners/v1/community/{community_id}/renter-household-by-xid/

Return a list of funnel_renter_ids (often referred to as client id or prospect id), from a renter household by xid

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

renter_household_xid

required

string

The external renter household identifier.

pms_integration_type

required

string

The PMS identifier to match the external renter_household_xid with. Valid values are [‘REALPAGE_ONESITE’, ‘YARDI’, ‘ENTRATA’].

should_have_active_lease

boolean

Excludes clients without an active lease.

Responses

200

Success

Array<object>

object

funnel_renter_id

string

group_assignment_status

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.