Query

GET https://{{domain}}/api/v5/objects/prospects?fields=id,addressOne,addressTwo,annualRevenue,campaignId,campaignParameter,salesforceCampaignId,city,comments,company,contentParameter,convertedAt,convertedFromObjectName,convertedFromObjectType,country,createdAt,createdById,salesforceAccountId,salesforceContactId,salesforceLastSync,salesforceLeadId,salesforceOwnerId,department,email,emailBouncedAt,emailBouncedReason,employees,fax,firstActivityAt,firstAssignedAt,firstName,firstReferrerQuery,firstReferrerType,firstReferrerUrl,grade,industry,isDeleted,isDoNotCall,isDoNotEmail,isEmailHardBounced,isReviewed,isStarred,jobTitle,lastActivityAt,lastName,mediumParameter,notes,optedOut,password,phone,prospectAccountId,salesforceId,salutation,score,source,sourceParameter,state,termParameter,territory,updatedAt,updatedById,userId,website,yearsInBusiness,zip,assignedToId,profileId,salesforceUrl,lifecycleStageId,recentInteraction,doNotSell

Request Params

KeyDatatypeRequiredDescription
fieldsstring(required) Prospect fields to return
deletedbooleanboolean - return deleted records
limitnumberinteger - the number of records to return. This value must be between 1 and 1000, inclusive. Default value is 200.
nextPageTokenstringthe server provided value to retrieve the next page
idnullOptional Integer Filter - filters the result by the id field
idGreaterThannullOptional Integer Filter - filters the result by the id field
idGreaterThanOrEqualTonullOptional Integer Filter - filters the result by the id field
idLessThannullOptional Integer Filter - filters the result by the id field
idLessThanOrEqualTonullOptional Integer Filter - filters the result by the id field
createdAtstringOptional DateTime Filter using createdAt field
createdAtBeforestringOptional DateTime Filter using createdAt field
createdAtBeforeOrEqualTostringOptional DateTime Filter using createdAt field
createdAtAfterstringOptional DateTime Filter using createdAt field
createdAtAfterOrEqualTostringOptional DateTime Filter using createdAt field
emailnullOptional String Filter using email field
lastActivityAtstringOptional DateTime Filter using lastActivityAt field
lastActivityAtBeforestringOptional DateTime Filter using lastActivityAt field
lastActivityAtBeforeOrEqualTostringOptional DateTime Filter using lastActivityAt field
lastActivityAtAfterstringOptional DateTime Filter using lastActivityAt field
lastActivityAtAfterOrEqualTostringOptional DateTime Filter using lastActivityAt field
salesforceIdnullOptional String Filter using salesforceId field
updatedAtstringOptional DateTime Filter using updatedAt field
updatedAtBeforestringOptional DateTime Filter using updatedAt field
updatedAtBeforeOrEqualTostringOptional DateTime Filter using updatedAt field
updatedAtAfterstringOptional DateTime Filter using updatedAt field
updatedAtAfterOrEqualTostringOptional DateTime Filter using updatedAt field
userIdnullOptional Integer Filter - filters the result by the userId field
userIdGreaterThannullOptional Integer Filter - filters the result by the userId field
userIdGreaterThanOrEqualTonullOptional Integer Filter - filters the result by the userId field
userIdLessThannullOptional Integer Filter - filters the result by the userId field
userIdLessThanOrEqualTonullOptional Integer Filter - filters the result by the userId field
userIdIsNullnullOptional Filter
userIdIsNotNullbooleanOptional Filter
assignedToIdnullOptional Integer Filter - filters the result by the assignedToId field
assignedToIdGreaterThannullOptional Integer Filter - filters the result by the assignedToId field
assignedToIdGreaterThanOrEqualTonullOptional Integer Filter - filters the result by the assignedToId field
assignedToIdLessThannullOptional Integer Filter - filters the result by the assignedToId field
assignedToIdLessThanOrEqualTonullOptional Integer Filter - filters the result by the assignedToId field
orderBystringstring - Order Results By: id, createdAt, lastActivityAt, updatedAt

HEADERS

KeyDatatypeRequiredDescription
Pardot-Business-Unit-Idstring
If-Modified-Sincestring