v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Candidate API:Attachments

Find attachments

get/candidates/attachments

Query parameters

CandidateIdinteger[]
TypeCandidateAttachmentType[]

Attachment types to include

Categorystring[]

Search by attachment category

CreatedAtstring[]

Search for candidate attachment 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 candidate attachment 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.

ExpiryDatestring[]

Search for candidate attachment expiring in the specified date range (ISO full-date). Prefix with < or > to search dates before or after (inclusive) the specified date. Specify multiple parameters to search for a range.

Embedstring[]

Embed related resources.<br /> Resources available to embed are: candidate

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

totalCountinteger required