Search offers for active Applicants
GET {{baseUrl}}/recruitment/hire/offers?pageNumber=1&offerAccepted={{offerAccepted}}&offerProcessed={{offerProcessed}}&formComplete={{formComplete}}
Result is limited to 100 records per page
Required OAuth scopes for authentication: Public.Offer.Read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pageNumber | number | Page number | |
offerAccepted | string | Whether the offer has been accepted or not | |
offerProcessed | string | Whether the offer has been processed or not | |
formComplete | string | Whether the form has been completed or not | |
offersAcceptedAfterProcessingAsUnprocessed | string | When set in conjunction with the "offerProcessed" = false, the result set will include both unprocessed offers along with offers that have been accepted post processsing in order to send the most recent / changed information again |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"Results":[{"PUReferenceID":"\u003cinteger\u003e","Processed":"\u003cboolean\u003e","ProcessedDate":"\u003cdateTime\u003e","OfferAcceptedDate":"\u003cdateTime\u003e","ApplicationInfo":{"ApplicationStatus":"\u003cstring\u003e","ApplicationStatusCode":"\u003cstring\u003e","ApplicationSubmitDate":"\u003cdateTime\u003e","ApplicantInfo":{"ApplicantID":"\u003cstring\u003e","ApplicantNumber":"\u003cinteger\u003e","FirstName":"\u003cstring\u003e","LastName":"\u003cstring\u003e","PhoneNumber":"\u003cstring\u003e","Email":"\u003cstring\u003e","BadgeID":"\u003cstring\u003e","PUReferenceID":"\u003cinteger\u003e"},"JobInfo":{"PUReferenceID":"\u003cinteger\u003e","JobID":"\u003cstring\u003e","Title":"\u003cstring\u003e","JobStatus":"\u003cstring\u003e","CreatedDate":"\u003cdateTime\u003e","LastModifiedDate":"\u003cdateTime\u003e"},"PUReferenceID":"\u003cinteger\u003e"},"OnboadingFormInfo":{"PUReferenceID":"\u003cinteger\u003e","Title":"\u003cstring\u003e","FormCompleted":"\u003cboolean\u003e"}},{"PUReferenceID":"\u003cinteger\u003e","Processed":"\u003cboolean\u003e","ProcessedDate":"\u003cdateTime\u003e","OfferAcceptedDate":"\u003cdateTime\u003e","ApplicationInfo":{"ApplicationStatus":"\u003cstring\u003e","ApplicationStatusCode":"\u003cstring\u003e","ApplicationSubmitDate":"\u003cdateTime\u003e","ApplicantInfo":{"ApplicantID":"\u003cstring\u003e","ApplicantNumber":"\u003cinteger\u003e","FirstName":"\u003cstring\u003e","LastName":"\u003cstring\u003e","PhoneNumber":"\u003cstring\u003e","Email":"\u003cstring\u003e","BadgeID":"\u003cstring\u003e","PUReferenceID":"\u003cinteger\u003e"},"JobInfo":{"PUReferenceID":"\u003cinteger\u003e","JobID":"\u003cstring\u003e","Title":"\u003cstring\u003e","JobStatus":"\u003cstring\u003e","CreatedDate":"\u003cdateTime\u003e","LastModifiedDate":"\u003cdateTime\u003e"},"PUReferenceID":"\u003cinteger\u003e"},"OnboadingFormInfo":{"PUReferenceID":"\u003cinteger\u003e","Title":"\u003cstring\u003e","FormCompleted":"\u003cboolean\u003e"}}],"TotalRecords":"\u003cinteger\u003e","TotalPages":"\u003cinteger\u003e","PageSize":"\u003cinteger\u003e","PageNumber":"\u003cinteger\u003e"}