v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Note API:Notes

Find notes

get/notes

Query parameters

CandidateIdinteger[]

Candidate Id

CompanyIdinteger[]

Company Id

ContactIdinteger[]

Contact Id

JobIdinteger[]

Job Id

RequisitionIdinteger[]

Requisition Id

ApplicationIdinteger[]

Job Application Id

PlacementIdinteger[]

Placement Id

EntityTypestring

Filter notes by Entity Type.<br /> Entity Type must be any of: candidate, contact, company, job, placement, requisition

Embedstring[]

Embed related resources.<br /> Resources available to embed are: self, candidates, contacts, placements, jobs, jobapplications, companies, requisitions Note: embed=self everything is embeded by default

NoteIdstring[]

Note Id

Typestring[]

Note type

Referencestring[]

Reference value used to identify a note or group of notes

CreatedAtstring[]

Search for notes 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.

UpdatedAtstring[]

Search for notes 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.

Sortstring[]

Sort the results by one or multiple fields, prefix with "-" to sort descending.<br /> Fields available for sorting are: type, createdAt, updatedAt

Fieldsstring[]

Additional fields to include with the results.<br /> Fields available to include are: text

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 notes matching the specified criteria

totalCountinteger required