Pardot's developer content is getting a makeover! Starting July 12th, you’ll be redirected to our new site.

Users

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

Supported Operations

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/users/<id>?<params>`	Admin > User > View ability
Query	`GET`	`https://pi.pardot.com/api/v5/objects/users?<params>`	Admin > User > View ability

Fields

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of the object.
`username`	String	Formatted as an email address, though distinct from the email field on the user object.
`isDeleted`	Boolean	True if the object is in the recycle bin in Pardot.

User Read

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

Example request:

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

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": 101,
    "username": "jane.doe@example.com",
    "isDeleted": "false"
}

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

Example request:

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

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 101,
            "username": "jane.doe@example.com",
            "isDeleted": "false"
        }
    ]
}

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 users where ID is equal to the given integer value.
`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.

Example request:

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

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 101,
            "username": "jane.doe@example.com",
        }
    ]
}