Unified API Reference
DashboardSignup For Free

Get Leads Batch

post
https://api.getknit.dev/v1.0/crm.lead.batch.get

Retrieve a batch of leads by ID, with optional filtering params.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

For schema of Lead object refer - Lead Data Model

This API may not return all fields defined in the response schema; for additional details, use the Get Lead by Id API.

Supported Apps

Apps supported via API

Salesforce (salesforce)

Supported Request Fields:

  • leadIds - Required
  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • ownerId
  • createdById
  • email
  • convertedAfter
  • convertedBefore
  • pageToken
  • originData

Supported Response Fields:

  • leads.info.id
  • leads.info.firstName
  • leads.info.lastName
  • leads.info.company
  • leads.info.description
  • leads.info.industry
  • leads.info.jobTitle
  • leads.info.website
  • leads.info.numberOfEmployees
  • leads.info.annualRevenue
  • leads.info.owner.id
  • leads.info.owner.email
  • leads.info.createdBy.id
  • leads.info.createdBy.email
  • leads.info.status
  • leads.info.updatedAt
  • leads.info.createdAt
  • leads.info.lastActivityAt
  • leads.addresses.addressLine1
  • leads.addresses.city
  • leads.addresses.state
  • leads.addresses.country
  • leads.addresses.zipCode
  • leads.addresses.addressType
  • leads.phones.type
  • leads.phones.phoneNumber
  • leads.emails.type
  • leads.emails.email
  • leads.conversion.convertedAt
  • leads.conversion.convertedAccountId
  • leads.conversion.convertedContactId
  • leads.conversion.convertedDealId
  • leads.customFields
  • nextPageToken
Zoho CRM (zoho-crm)

Supported Request Fields:

  • leadIds - Required
  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • ownerId
  • createdById
  • email
  • pageToken
  • originData

Supported Response Fields:

  • leads.info.id
  • leads.info.firstName
  • leads.info.lastName
  • leads.info.company
  • leads.info.description
  • leads.info.industry
  • leads.info.jobTitle
  • leads.info.website
  • leads.info.numberOfEmployees
  • leads.info.annualRevenue
  • leads.info.owner.id
  • leads.info.owner.email
  • leads.info.createdBy.id
  • leads.info.createdBy.email
  • leads.info.status
  • leads.info.updatedAt
  • leads.info.createdAt
  • leads.info.lastActivityAt
  • leads.phones.type
  • leads.phones.phoneNumber
  • leads.emails.type
  • leads.emails.email
  • leads.conversion.convertedAt
  • leads.conversion.convertedAccountId
  • leads.conversion.convertedContactId
  • leads.conversion.convertedDealId
  • nextPageToken
Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

  • leadIds - Required
  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • ownerId
  • createdById
  • email
  • pageToken
  • originData

Supported Response Fields:

  • leads.info.id
  • leads.info.firstName
  • leads.info.lastName
  • leads.info.company
  • leads.info.industry
  • leads.info.description
  • leads.info.jobTitle
  • leads.info.website
  • leads.info.numberOfEmployees
  • leads.info.annualRevenue
  • leads.info.owner.id
  • leads.info.owner.email
  • leads.info.createdBy.id
  • leads.info.createdBy.email
  • leads.info.status
  • leads.info.updatedAt
  • leads.info.createdAt
  • leads.addresses.addressLine1
  • leads.addresses.addressLine2
  • leads.addresses.city
  • leads.addresses.state
  • leads.addresses.country
  • leads.addresses.zipCode
  • leads.addresses.addressType
  • leads.phones.phoneNumber
  • leads.emails.email
  • nextPageToken

📘

To see the list of supported filters for an app, refer - CRM List Leads Filter Support Matrix

Note: To ensure optimal performance and reliability, we recommend limiting each request to a maximum of 100 IDs. Requests with a larger number of IDs may experience degraded performance or intermittent errors — if you need to fetch more, please split your list into batches of 100 or fewer.

Body Params
leadIds
array of strings
required
leadIds*
string
boolean
Defaults to false
date-time

Filters leads which were created after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters leads which were created before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters leads which were updated after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters leads which were updated before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

ownerId
array of strings

Filters leads by one or more owner ids. Supports multiple values as a list of string.

ownerId
createdById
array of strings

Filters leads by one or more creator ids. Supports multiple values as a list of string.

createdById
email
array of strings

Filters leads by one or more emails. Supports multiple values as a list of string.

email
date-time

Filters leads which were converted after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

date-time

Filters leads which were converted before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?