v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Gets all leads

The limit and offset Parameters can be used for paging purposes.

When supplied, the limit value should be greater than or equal to one. If the value is omitted, zero or a negative number then all results after the offset will be returned.

When supplied, the offset should be greater than or equal to zero. If the value is omitted or a negative number then results will start from the first page.

Results are ordered by Created date in descending order

get/Entity/Leads

Query parameters

createdSincestring date-time nullable

Optionally filter leads created since a specific date and time

mobileNumberstring nullable

Optionally filter leads that have a matching mobile number

emailAddressstring nullable

Optionally filter leads that have a matching email address

returnPhotosboolean nullable

Optionally return lead photos

limitinteger nullable

Optionally limit the number of results to return in one request.

offsetinteger nullable

Optionally set the number of results to skip before returning the results.

Response

Idinteger
Photostring byte nullable
Descriptionstring nullable
Forenamestring nullable
Surnamestring nullable
JobTitlestring nullable
ClientJobTitlestring nullable
JobDescriptionstring nullable
Companystring nullable
CompanyNotesstring nullable
ContactNotesstring nullable
PhoneNumberstring nullable
MobileNumberstring nullable
EmailAddressstring nullable
LinkedInUrlstring nullable
WebsiteUrlstring nullable
Addressstring nullable
Sourcestring nullable
Tagsstring nullable
OwningConsultantIdinteger
Status'New' | 'Contacted' | 'Nurture' | 'Qualified' | 'Disqualified'
Createdstring date-time
LinkedCompanyIdinteger nullable
LinkedCompanyTierContactIdinteger nullable