v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Contact API:Contacts

Find contacts

get/contacts

Query parameters

ContactIdinteger[]

Contact Id

Namestring

Contact name

Emailstring

Contact email

Phonestring

Contact phone or mobile number

CompanyIdinteger[]

Company Id

HiringManagerboolean
StatusIdinteger[]
PartnerAction.ActionIdstring[]

Unique identifier for partner actions

PartnerAction.Referencestring[]

Partner supplied unique reference for the action

PartnerAction.StagePartnerActionStage[]

Include partner actions at a specific stage

PartnerAction.SubmittedAtstring[]

Search for entities submitted to an action at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

FolderIdinteger[]

Search in specific folders

CreatedByinteger[]

User Id - search for contacts created by the specified user(s)

CreatedAtstring[]

Search for contacts created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

UpdatedByinteger[]

User Id - search for contacts last updated by the specified user(s)

UpdatedAtstring[]

Search for contacts updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Fieldsstring[]

Additional fields to include with the results. Fields available to include are: partnerActions

Embedstring[]

Embed related resources.<br /> Resources available to embed are: self, skills, notes, jobs

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of contacts matching the specified criteria

totalCountinteger required