GET v2/people.json

_query (string, query, optional)

For internal use only. This field does not comply with our backwards compatibility policies. This filter is for authenticated users of Salesloft only and will not work for OAuth Applications. Filters people by the string provided. Can search and filter by name, title, industry, email_address and linked account name.

account_id (array, query, optional)

Filters people by the account they are linked to. Multiple account ids can be applied

bounced (boolean, query, optional)

Filters people by whether an email that was sent to them bounced or not.

cadence_id (array, query, optional)

Filters people by the cadence that they are currently on. Multiple cadence_ids can be applied. An additional value of "_is_null" can be passed to filter people that are not on a cadence.

can_call (boolean, query, optional)

Includes people that can be called given do_not_contact and contact_restrictions property

can_email (boolean, query, optional)

Includes people that can be emailed given do_not_contact and contact_restrictions property

can_text (boolean, query, optional)

Includes people that can be sent a text message given do_not_contact and contact_restrictions property

city (array, query, optional)

Filters people by their city by exact match. Supports partial matching

country (array, query, optional)

Filters people by their country by exact match. Supports partial matching

created_at (object, query, optional)

Equality filters that are applied to the last_contacted field. A single filter can be used by itself or combined with other filters to create a range. ---CUSTOM--- {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}

crm_id (array, query, optional)

Filters people by crm_id. Multiple crm ids can be applied

custom_fields (object, query, optional)

Filters by people matching all given custom fields. The custom field names are case-sensitive, but the provided values are case-insensitive. Example: v2/people?custom_fields[custom_field_name]=custom_field_value

do_not_contact (boolean, query, optional)

Includes people that have a given do_not_contact property

email_addresses (array, query, optional)

Filters people by email address. Multiple emails can be applied. An additional value of "_is_null" can be passed to filter people that do not have an email address.

eu_resident (boolean, query, optional)

Filters people by whether or not they are marked as an European Union Resident or not.

ids (array, query, optional)

IDs of people to fetch. If a record can't be found, that record won't be returned and your request will be successful

import_id (array, query, optional)

Filters people that were imported by the given import ids. Multiple import ids can be applied. An additional value of "_is_null" can be passed to filter people that were not imported.

include_paging_counts (boolean, query, optional)

Whether to include total_pages and total_count in the metadata. Defaults to false

job_seniority (array, query, optional)

Filters people by job seniorty. Multiple job seniorities can be applied. An additional value of "_is_null" can be passed to filter people do not have a job_seniority.

last_contacted (object, query, optional)

Equality filters that are applied to the last_contacted field. A single filter can be used by itself or combined with other filters to create a range. Additional values of "_is_null" or "_is_not_null" can be passed to filter records that either have no timestamp value or any timestamp value. ---CUSTOM--- {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}

limit_paging_counts (boolean, query, optional)

Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

locales (array, query, optional)

Filters people by locales. Multiple locales can be applied. An additional value of "Null" can be passed to filter people that do not have a locale.

new (boolean, query, optional)

Filters people by whether or not that person is on a cadence or if they have been contacted in any way.

owned_by_guid (array, query, optional)

Filters people by the owner's guid. Multiple owner guids can be applied

owner_crm_id (array, query, optional)

Filters people by owner_crm_id. Multiple owner_crm_ids can be applied. An additional value of "_is_null" can be passed to filter people that are unowned. A "_not_in" modifier can be used to exclude specific owner_crm_ids. Example: v2/people?owner_crm_id[_not_in]=id

owner_id (array, query, optional)

Filters people by owner_id. Multiple owner_ids can be applied.

owner_is_active (boolean, query, optional)

Filters people by whether the owner is active or not.

page (integer, query, optional)

The current page to fetch results from. Defaults to 1

per_page (integer, query, optional)

How many records to show per page in the range [1, 100]. Defaults to 25

person_stage_id (array, query, optional)

Includes people that have a given person_stage. Multiple person stage ids can be applied. An additional value of "_is_null" can be passed to filter people that do not have a stage set.

phone_number (boolean, query, optional)

Filter people by whether or not they have a phone number or not

replied (boolean, query, optional)

Filters people by whether or not they have replied to an email or not.

sort_by (string, query, optional)

Key to sort on, must be one of: created_at, updated_at, last_contacted_at, name, title, job_seniority, call_count, sent_emails, clicked_emails, replied_emails, viewed_emails, account, cadence_stage_name. Defaults to updated_at

sort_direction (string, query, optional)

Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

starred_by_guid (array, query, optional)

Filters people who have been starred by the user guids given.

state (array, query, optional)

Filters people by their state by exact match. Supports partial matching

success (boolean, query, optional)

Filters people by whether or not they have been marked as a success or not.

tag_id (array, query, optional)

Filters people by the tag ids applied to the person. Multiple tag ids can be applied.

title (array, query, optional)

Filters people by their title by exact match. Supports partial matching

updated_at (array, query, optional)

Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range. ---CUSTOM--- {"type":"object","keys":[{"name":"gt","type":"iso8601 string","description":"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"gte","type":"iso8601 string","description":"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lt","type":"iso8601 string","description":"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision."},{"name":"lte","type":"iso8601 string","description":"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision."}]}