Skip to main content

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

GET
/api/partners/v1/community/:community_id/renter-household-by-xid/

Request

Example requestGET
$ curl -X GET \
    -H "Authorization: Bearer YOUR_API_KEY" \
    "https://api.funnelleasing.com/api/partners/v1/community/1234/renter-household-by-xid/"

Response

Example responseJSON200 · application/json
[
{
"funnel_renter_id": "string",
"group_assignment_status": "string"
}
]