Candidate
Candidate represents a candidate in the Recrubo platform. The candidate object contains all the information about the candidate, such as name, email, phone number, and postal code. The candidate object also contains a reference to the current status of the candidate. To use the Recrubo Inbox, Candidates need to be created in Recrubo. To support the Inbox a candidate requires a MessageThread
Endpoints
GET /candidates- Retrieves a list of all candidates.GET /candidates/{id}- Retrieves a specific candidate by ID.GET /candidates/{id}?include=candidateStatus- Retrieves a specific candidate by ID with its current status.POST /candidates- Creates a new candidate.PATCH /candidates/{id}- Updates a specific candidate by ID.DELETE /candidates/{id}- Deletes a specific candidate by ID.
Attributes
firstName
String
The firstName for the candidate.
lastName
String
The lastName for the candidate.
String
The email for the candidate.
phone
String
The phone number for the candidate.
postalCode
String
The postal code of the current living location for the candidate.
candidateStatusId
String
A UUID referencing the current status of the candidate.
deletedAt
DateTime
The timestamp when the candidate was deleted.
createdAt
DateTime
The timestamp when the candidate was created.
updatedAt
DateTime
The timestamp when the candidate was last updated.
HTTP Methods
firstName
X
X
x
lastName
X
X
X
X
x
x
phone
X
x
x
postalCode
X
X
X
candidateStatusId
X
X
X
deletedAt
X
createdAt
X
updatedAt
X
Required Fields for Creation (POST)
phone
String
31612345678
Example POST body
Example PATCH body with locations
OpenAPI
Bearer
candidate found with included candidateStatus
candidate found with included candidateStatus
Last updated