v1
latestOpenAPI 3.0.02026-07-24226294602.4 KBLead
Get Leads
Get a list of Leads.
get/leads
Query parameters
sortstring
Specifies the order in which the Lead list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on
pageinteger
Specifies the page of records to be returned. Defaults to 1.
page_sizeinteger
Number of records to return per page. Maximum and default are 100 records.
Headers
x-api-keystring required
A valid API key. If you don't have one, please request one through the Web Integrations screen.
Response
Lead record list.
Example response
{
"leads": [
{
"id": 1234567891234567,
"lead_status_id": 1234567891234567,
"location_id": 1234567891234567,
"date_of_birth": "2014-12-31",
"created": {
"created_by_id": 1234567891234567,
"created_on_datetime": "2014-12-31T23:59:59.938Z"
},
"updated": {
"updated_by_id": 1234567891234567,
"updated_on_datetime": "2014-12-31T23:59:59.938Z"
},
"last_contact_datetime": "2014-12-31T23:59:59.938Z",
"lead_source_id": 1234567891234567,
"referred_by_user_id": 1234567891234567,
"location_timezone_id": 1234567891234567,
"created_from_source_id": 1234567891234567,
"lead_owner_id": 1234567891234567,
"last_class_sign_in": "2014-12-31T23:59:59.938Z",
"last_booking_sign_in": "2014-12-31T23:59:59.938Z",
"next_class_reservation": "2014-12-31T23:59:59.938Z",
"next_appointment_booking": "2014-12-31T23:59:59.938Z"
}
]
}