Get lead
/api/v2/leads/{lead}Authorization
bearerAuth In: header
Path Parameters
uuidQuery Parameters
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843", "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9", "lead_source_id": 0, "email": "string", "name": "string", "phone": "string", "message": "string", "move_in_date": "2019-08-24", "tour": { "date": "string", "time": "string", "type": "string" }, "submission": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}List leads GET
Leads in the account, newest first. Requires permission to view leads; a user restricted to some groups sees the leads of the properties in those groups. Poll with `created_at[gt]` set to the newest lead you hold.
V1 API overview
The public delivery API. Render-ready payloads for one property, and the public writes a website or widget needs.