Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Lead

Retrieves the collection of Lead resources.

Retrieves the collection of Lead resources.

get/leads

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Lead collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring
emailstring nullable

lead email address

firstNamestring nullable

lead first name

lastNamestring nullable

lead last anme

primaryPhonestring nullable

lead phone number

addressLine1string nullable

line1 address of the lead

citystring nullable

city address of the lead

countrystring nullable

country address of the lead

companystring nullable

company where lead is working on

postalCodestring nullable

postal code of the lead

websitestring nullable

website of the lead

industrystring nullable

the industry lead belongs to

skypeUsernamestring nullable

skype username of the lead

twitterstring nullable

twitter account of the lead

annualRevenuestring nullable

annual revenue of the company lead is working

employeeCountinteger nullable

number of employees in the company lead works in

createdstring date-time nullable

date and time lead's information is first created

modifiedstring date-time nullable

date and time lead's information is last updated

Example response

[
  {
    "id": "quickbooks-726",
    "integration": "quickbooks",
    "srcId": "90300000072369",
    "email": "ron.aurthor@gmail.com",
    "firstName": "Ronald",
    "lastName": "Aurthor",
    "primaryPhone": "416-555-0126",
    "addressLine1": "39 Parliment road",
    "city": "Detroit",
    "country": "United States",
    "company": "Ronalds Hot Rods",
    "postalCode": "48653",
    "website": "https://www.ronshotrods.com",
    "industry": "Automotive",
    "skypeUsername": "ronaldAurthor0127",
    "twitter": "@ronaldAutomotive",
    "annualRevenue": "50000000",
    "employeeCount": 113,
    "created": "2021-07-28 00:00:00",
    "modified": "2021-09-15 00:00:00"
  }
]