List leads
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.
/api/v2/leadsLeads 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.
Authorization
bearerAuth In: header
Query 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.
uuid1 <= value <= 20015uuidOnly leads submitted through this form.
uuidOnly tours booked against this connection.
uuidOnly leads attributed to this lead source.
Partial match on the email.
Exact created_at, or a range with created_at[gte], created_at[lte], created_at[gt] and created_at[lt].
Sort by any filter field; prefix with - for descending. Defaults to newest first.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/leads"{ "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" } ], "links": { "first": "string", "last": "string", "prev": "string", "next": "string" }, "meta": { "current_page": 0, "from": 0, "last_page": 0, "links": [ { "url": "string", "label": "string", "page": 0, "active": true } ], "path": "string", "per_page": 200, "to": 0, "total": 0 }}