Get a Prospect

GET

/api/partners/v1/community/{community_id}/prospects/{prospect_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

prospect_id

required

string

The client’s funnel id (often referred to as client id or funnel renter id), this will look like ‘12345’.

Example

12345

Query Parameters

exclude_moved_out

boolean

Exclude persons of the household if they have moved out in the people attribute of the response.

exclude_minors

boolean

Exclude persons of the household if they’re a minor in the people attribute of the response.

Responses

200

Success

object

funnel_renter_id

integer

7

funnel_community_id

integer

nullable

1234

status

string

Allowed values: Prospect Toured Applicant Resident Did Not Rent Client Merged Client Deleted Vendor/Spam Former Resident

lead_source

string

nullable

Google My Business

move_in_date

string format: date-time

nullable

2023-04-26

layouts

Array<string>

Allowed values: Studio Efficiency Alcove Studio Jr 1 Bedroom 1 Bedroom Convertible 1 Bedroom w/ Den Jr 4 2 Bedroom 2 Bedroom w/ Den 3 Bedroom 3 Bedroom w/ Den 4 Bedroom 5 Bedroom 6+ Bedroom Loft 4 Room 5 Room 6 Room 7 Room 8 Room Flex 2 Flex 3 Flex 4 Studio w/ HO 1 Bedroom w/ HO 2 Bedroom w/ HO 3 Bedroom w/ HO 4 Bedroom w/ HO Building

created_at

string format: date-time

2023-04-26T02:08:12

people

Array<object>

object

id

integer

7

first_name

string

Mike

last_name

string

Jones

email

string

stilltippin@fofos.com

phone_1

string

nullable

803-123-1234

phone_2

string

nullable

sms_opt_in

boolean

email_updates_opt_in

boolean

is_minor

boolean

nullable

listings

Array<object>

object

funnel_unit_id

integer

nullable

7

property_address

string

nullable

550 Memory Lane

property_internal_id

string

nullable

123456

messages

Array<object>

object

message

string

Move-In Timeline : 5/26/2023\r\nTour Appointment Date/Time : 04-29-2023 01:15 PM\r\nLink : https://myperqleads.com/03dty03buze6c3xz\r\nAutomated SMS Opt-in : Yes\r\nLead Source : Google My Business\r\n\r\nCRM Qualification Date : 04-25-2023 09:08 PM (Central Daylight Time)

received_at

string format: date-time

2023-04-26T02:08:12

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.