Sign in

v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Gets all candidates

The limit and offset Parameters can be used for paging purposes.

When supplied, the limit value should be greater than or equal to one. If the value is omitted, zero or a negative number then all results after the offset will be returned.

When supplied, the offset should be greater than or equal to zero. If the value is omitted or a negative number then results will start from the first page.

Results are ordered by LastUpdated date in descending order

get/Entity/Candidates

Query parameters

lastUpdatedSincestring date-time nullable

Optionally filter candidates updated since a specific date and time

tempCandidatesOnlyboolean

Optionally filter candidates that are marked as Temp candidates

mobileNumberstring nullable

Optionally filter candidates that have a matching mobile number

phonestring nullable

Optionally filter candidates that have any matching phone number. This includes landlines and mobile numbers.

emailAddressstring nullable

Optionally filter candidates that have a matching email address

limitinteger nullable

Optionally limit the number of results to return in one request.

offsetinteger nullable

Optionally set the number of results to skip before returning the results.

Response

Idinteger required
Forenamestring required
Surnamestring required
DateOfBirthstring date-time nullable
IsTempboolean required
IsActiveboolean required
Createdstring date-time required
LastUpdatedstring date-time required