User Object

User resources tell you about the Account Engagement 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.

Note

Supported Operations

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/users/<id>?<params>`	Admin > User > View
Query	`GET`	`https://pi.pardot.com/api/v5/objects/users?<params>`	Admin > User > View
Add Tag	`POST`	`https://pi.pardot.com/api/v5/objects/users/<id>/do/addTag`	Admin > User > Create AND Marketing > Segmentation > Tags > Create
Remove Tag	`POST`	`https://pi.pardot.com/api/v5/objects/users/<id>/do/removeTag`	Admin > User > Create AND Marketing > Segmentation > Tags > Create

Fields

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of the object.
`email`	String	Email address of the user.
`firstName`	String	First name of the user.
`username`	String	Formatted as an email address, though distinct from the email field on the user object.
`jobTitle`	String	Job title of the user.
`role`	String	Role ID of the user.
`roleName`	String	Role name of the user.
`salesforceId`	String	Salesforce Id of the object.
`isDeleted`	Boolean	True if the object is in the recycle bin in Account Engagement.
`createdAt`	DateTime	Creation time of this object.
`updatedAt`	DateTime	Last updated time for the object.
`createdById`	Integer	ID of the user who created the object.
`updatedById`	Integer	ID of the user who last updated the object.
`createdBy`	User	User object representing the user who created the object. See documentation for User for fields.
`updatedBy`	User	User object representing the user who last updated the object. See documentation for User for fields.
`tagReplacementLanguage`	Enum	Merge language of the user signature. Can be `"pml"`, `"hml"`, or `"undetermined"`.

User Read

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

Example request:

1GET /api/v5/objects/users/101?fields=id,isDeleted,role,roleName,username
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "id": 101,
5    "isDeleted": false,
6    "role": "1",
7    "roleName": "Administrator",
8    "username": "jane.doe@example.com"
9}

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:

1GET /api/v5/objects/users?fields=id,isDeleted,role,roleName,username&orderBy=id
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "values": [
5        {
6            "id": 101,
7            "isDeleted": false,
8            "role": "1",
9            "roleName": "Administrator",
10            "username": "jane.doe@example.com"
11        }
12    ]
13}

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.

Parameter	Description
`id`	Returns any user where ID is equal to the given integer value.
`idList`	Returns any user where ID is included in the given list of values.
`idGreaterThan`	Returns any users where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any users where ID is greater than or equal to the specified value.
`idLessThan`	Returns any users where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any users where ID is less than or equal to the specified value.
`email`	Returns any user where Email is equal to the given string value.
`createdAt`	Returns any user where CreatedAt is equal to the given datetime value.
`createdAtAfter`	Returns any user where CreatedAt is after the given datetime value, non-inclusive.
`createdAtAfterOrEqualTo`	Returns any user where CreatedAt is after or equal to the given datetime value.
`createdAtBefore`	Returns any user where CreatedAt is before the given datetime value, non-inclusive.
`createdAtBeforeOrEqualTo`	Returns any user where CreatedAt is before or equal to the given datetime value.
`updatedAt`	Returns any user where UpdatedAt is equal to the given datetime value.
`updatedAtAfter`	Returns any user where UpdatedAt is after the given datetime value, non-inclusive.
`updatedAtAfterOrEqualTo`	Returns any user where UpdatedAt is after or equal to the given datetime value.
`updatedAtBefore`	Returns any user where UpdatedAt is before the given datetime value, non-inclusive.
`updatedAtBeforeOrEqualTo`	Returns any user where UpdatedAt is before or equal to the given datetime value.
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.

Example request:

1GET /api/v5/objects/users?fields=id,username&orderBy=id desc&idGreaterThan=100&idLessThan=200
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "values": [
5        {
6            "id": 101,
7            "username": "jane.doe@example.com"
8        }
9    ]
10}

Add Tag

Adds a Tag to the User object, which creates a TaggedObject.

Example Request

1POST https://pi.pardot.com/api/v5/objects/users/1000/do/addTag
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json
5
6{
7    "tagId": 100
8}

Example Response

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "id": 610,
5    "createdAt": "2024-09-23T18:26:49-04:00",
6    "createdById": 250,
7    "objectId": 1000,
8    "objectType": "user",
9    "tagId": 100
10}

Remove Tag

Remove a tag from a User object. When you remove a tag, the associated TaggedObject record is deleted.

Example Request

1POST `https://pi.pardot.com/api/v5/objects/users/1000/do/removeTag`
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json
5
6{
7    "tagId": 100
8}

Example Response

Returns code 204 no content.