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
Key | Datatype | Required | Description |
---|
fields | string | | (required) Prospect fields to return |
deleted | boolean | | boolean - return deleted records |
limit | number | | integer - the number of records to return. This value must be between 1 and 1000, inclusive. Default value is 200. |
nextPageToken | string | | the server provided value to retrieve the next page |
id | null | | Optional Integer Filter - filters the result by the id field |
idGreaterThan | null | | Optional Integer Filter - filters the result by the id field |
idGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the id field |
idLessThan | null | | Optional Integer Filter - filters the result by the id field |
idLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the id field |
createdAt | string | | Optional DateTime Filter using createdAt field |
createdAtBefore | string | | Optional DateTime Filter using createdAt field |
createdAtBeforeOrEqualTo | string | | Optional DateTime Filter using createdAt field |
createdAtAfter | string | | Optional DateTime Filter using createdAt field |
createdAtAfterOrEqualTo | string | | Optional DateTime Filter using createdAt field |
email | null | | Optional String Filter using email field |
lastActivityAt | string | | Optional DateTime Filter using lastActivityAt field |
lastActivityAtBefore | string | | Optional DateTime Filter using lastActivityAt field |
lastActivityAtBeforeOrEqualTo | string | | Optional DateTime Filter using lastActivityAt field |
lastActivityAtAfter | string | | Optional DateTime Filter using lastActivityAt field |
lastActivityAtAfterOrEqualTo | string | | Optional DateTime Filter using lastActivityAt field |
salesforceId | null | | Optional String Filter using salesforceId field |
updatedAt | string | | Optional DateTime Filter using updatedAt field |
updatedAtBefore | string | | Optional DateTime Filter using updatedAt field |
updatedAtBeforeOrEqualTo | string | | Optional DateTime Filter using updatedAt field |
updatedAtAfter | string | | Optional DateTime Filter using updatedAt field |
updatedAtAfterOrEqualTo | string | | Optional DateTime Filter using updatedAt field |
userId | null | | Optional Integer Filter - filters the result by the userId field |
userIdGreaterThan | null | | Optional Integer Filter - filters the result by the userId field |
userIdGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the userId field |
userIdLessThan | null | | Optional Integer Filter - filters the result by the userId field |
userIdLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the userId field |
userIdIsNull | null | | Optional Filter |
userIdIsNotNull | boolean | | Optional Filter |
assignedToId | null | | Optional Integer Filter - filters the result by the assignedToId field |
assignedToIdGreaterThan | null | | Optional Integer Filter - filters the result by the assignedToId field |
assignedToIdGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the assignedToId field |
assignedToIdLessThan | null | | Optional Integer Filter - filters the result by the assignedToId field |
assignedToIdLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the assignedToId field |
orderBy | string | | string - Order Results By: id, createdAt, lastActivityAt, updatedAt |
Key | Datatype | Required | Description |
---|
Pardot-Business-Unit-Id | string | | |
If-Modified-Since | string | | |