User Object

User resources tell you about the Pardot users in your organization. Learn more about users in Salesforce Help.

The API to access the User object follows the conventions described in Version 5 Overview.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

User Resources

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/users/<id>?<params>Admin > User > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/users?<params>Admin > User > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
emailStringEmail address of the user.
firstNameStringFirst name of the user.
usernameStringFormatted as an email address, though distinct from the email field on the user object.
jobTitleStringJob title of the user.
roleStringRole of the user.
salesforceIdStringSalesforce Id of the object.
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
createdAtDateTimeCreation time of this object.
updatedAtDateTimeLast updated time for the object.
createdByIdIntegerID of the user who created the object.
updatedByIdIntegerID of the user who last updated the object.
createdByUserUser object representing the user who created the object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated the object. See documentation for User for fields.

User Read

Retrieve a single user following the conventions described in the Version 5 Overview.

Example request:

Example response:

User Query

Retrieving a collection of users follows the conventions described in Version 5 Overview.

Sortable Fields

When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.

  • id
  • createdAt
  • updatedAt

Example request:

Example response:

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

ParameterDescription
idReturns any user where ID is equal to the given integer value.
idGreaterThanReturns any users where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any users where ID is greater than or equal to the specified value.
idLessThanReturns any users where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any users where ID is less than or equal to the specified value.
emailReturns any user where Email is equal to the given string value.
createdAtReturns any user where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any user where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any user where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any user where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any user where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any user where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any user where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any user where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any user where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any user where UpdatedAt is before or equal to the given datetime value.

Example request:

Example response: