Query
GET https://{{domain}}/api/v5/objects/visitors?fields=id,campaignId,campaignParameter,contentParameter,hostname,ipAddress,isDeleted,mediumParameter,pageViewCount,prospectId,sourceParameter,termParameter,createdAt,updatedAt,isIdentified,doNotSell
Request Params
Key | Datatype | Required | Description |
---|
fields | string | | (required) Visitor 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 |
prospectId | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdGreaterThan | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdLessThan | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the prospectId 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 |
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 |
isIdentified | boolean | | Optional Boolean Filter using isIdentified field |
orderBy | string | | string - Order Results By: id, prospectId, createdAt, updatedAt |
Key | Datatype | Required | Description |
---|
Pardot-Business-Unit-Id | string | | |
If-Modified-Since | string | | |