Qodex.ai
Qodex.ai
Introduction
Public - Assessment API
UAT
Assessment package: add/update - [UAT]Assessment package: archive - [UAT]Assessment order: get - [UAT]Assessment order: acknowledge - [UAT]Assessment: notify ready for review - [UAT]Assessment: notify report - [UAT]
PROD
Assessment package: add/update - [PROD]Assessment package: archive - [PROD]Assessment order: get - [PROD]Assessment order: acknowledge - [PROD]Assessment: notify ready for review - [PROD]Assessment: notify report - [PROD]
Public - Auth Access Token
GetToken
Public - BackgroundCheck API
GetBackgroundCheckRequestUpdateBackgroundCheck
Public - Core HR API
Agreement API
Agreement
Agreement Type API
AgreementType
Agreement Classification API
AgreementClassification
Business Unit API
BusinessUnitLevel1BusinessUnitLevel2BusinessUnitLevel3BusinessUnitLevel4
Cost Centre API
CostCentre
Site API
Site
Payscale API
Payscale
Role API
Role
Generic List API
GenericList
Team API
Team
Position API
Position
Employee API
EmployeeEmployeeByPageUpID
Public - Recruitment API
Hire API-Job
Get job by PageUp job ID / PUReferenceID (lJobID)Update job by PageUp job ID / PUReferenceID (lJobID)Get job position by PageUp job ID / PUReferenceID (lJobID)Search jobsCreate job
Hire API-Offer
Get offer by PageUp Offer ID (lOfferID)Update offer by PageUp Offer ID (lOfferID - Offer PUReferenceID)Get offer checks by PageUp Offer ID (lOfferID - Offer PUReferenceID)Get onboarding form and the answers by PageUp Offer ID (New Starter Form)Get offer/s by PageUp Application ID (lApplicationID)Create offer by PageUp Application ID (lApplicationID / Application - PUReferenceID)Get offer/s for review assigned to a PageUp user (By user email address)Search offers for active ApplicantsMark offers as processed based on a list of Application IDs (limited to max 100 application Ids per API request)Set offer status by PageUp Offer ID (lOfferID)Mark offers as processed by PageUp Offer ID (lOfferID)Reset offers as not processed by PageUp Offer ID (lOfferID)Set offer status by PageUp Application ID (lApplicationID)
Hire API-SearchApplications
Get applicant by PageUp Applicant ID (lApplicantID)Get application by PageUp Application ID (lApplicationID)Get application form and the answers by PageUp Application ID (lApplicationID)Search active applicationsSearch active applications by Job ID
Document API
Returns metadata about a specific documentReturns the URL of the document for download.Generate a Amazon S3 presigned URL for uploading a document toCreate new or update existing Document in the PageUp system with a newly uploaded file from Amazon S3 temp storage
Application API
Returns a single Application using the received application idAllows the update of an application's sFlagX string values, which are often used to store additional application data and shown in the Manage Applications page.Change an Application's ApplicationStatus (by the Status ID).Change an Application's ApplicationStatus (by the Status Code).Allows the changing of an application's order of merit (rank).Returns a list of applications associated with the specified Job IdCreates and returns a single Application using the received application jsonSubmits a single Application using the received application idReturns a list of applications associated with the specified applicant id
Public - Work Compliance API
UAT
GetInvitation- [UAT]AddStatus - [UAT]UpdateInvitation- [UAT]
PROD
GetInvitation- [PROD]AddStatus - [PROD]UpdateInvitation- [PROD]
obsolete - Application API
UAT
GetApplicationByApplicantID - [UAT]GetApplicationByApplicationID - [UAT]GetApplicationsByJobID - [UAT]CreateApplication - [UAT]ChangeApplicationByStatusCode - [UAT]
PROD
GetApplicationByApplicantID - [PROD]GetApplicationByApplicationID - [PROD]GetApplicationsByJobID - [PROD]CreateApplication - [PROD]ChangeApplicationByStatusCode - [PROD]
obsolete - Recruitment API
Applicant API
GetApplicantByApplicantID - [UAT]GetApplicantByApplicantID - [PROD]CreateApplicant - [UAT]CreateApplicant - [PROD]GetApplicantByEmail - [UAT]GetApplicantByEmail - [PROD]
Hire API-Job-UAT
GetJobByJobID - [UAT]GetJobPositionByPageUpJobID - [UAT]SearchJobs - [UAT]
Hire API-Job-PROD
GetJobByJobID - [PROD]GetJobPositionByPageUpJobID - [PROD]SearchJobs - [PROD]
Hire API-Offer-UAT
GetOfferByOfferID - [UAT]GetOfferChecksByOfferID - [UAT]GetOnboardingFormAnswersByOfferID - [UAT]SearchOffersForActiveApplicants - [UAT]
Hire API-Offer-PROD
GetOfferChecksByOfferID - [PROD]GetOnboardingFormAnswersByOfferID - [PROD]SearchOffersForActiveApplicants - [PROD]
Hire API-SearchApplications-UAT
GetApplicantByPageUpApplicantID - [UAT]SearchActiveApplications - [UAT]SearchActiveApplicationsByJobID - [UAT]GetApplicationFormAnswersByApplicationID - [UAT]
Hire API-SearchApplications-PROD
GetApplicantByPageUpApplicantID - [PROD]SearchActiveApplications - [PROD]SearchActiveApplicationsByJobID - [PROD]GetApplicationFormAnswersByApplicationID - [PROD]
Document API-UAT
GetDocumentMetadataByDocumentID - [UAT]GetDocumentDownloadURL - [UAT]PrepareTempDirectUpload - [UAT]MoveFromTemp - [UAT]
Document API-PROD
GetDocumentMetadataByDocumentID - [PROD]GetDocumentDownloadURL - [PROD]PrepareTempDirectUpload - [PROD]MoveFromTemp - [PROD]
Introduction
Public - Assessment API
UAT
Assessment package: add/update - [UAT]Assessment package: archive - [UAT]Assessment order: get - [UAT]Assessment order: acknowledge - [UAT]Assessment: notify ready for review - [UAT]Assessment: notify report - [UAT]
PROD
Assessment package: add/update - [PROD]Assessment package: archive - [PROD]Assessment order: get - [PROD]Assessment order: acknowledge - [PROD]Assessment: notify ready for review - [PROD]Assessment: notify report - [PROD]
Public - Auth Access Token
GetToken
Public - BackgroundCheck API
GetBackgroundCheckRequestUpdateBackgroundCheck
Public - Core HR API
Agreement API
Agreement
Agreement Type API
AgreementType
Agreement Classification API
AgreementClassification
Business Unit API
BusinessUnitLevel1BusinessUnitLevel2BusinessUnitLevel3BusinessUnitLevel4
Cost Centre API
CostCentre
Site API
Site
Payscale API
Payscale
Role API
Role
Generic List API
GenericList
Team API
Team
Position API
Position
Employee API
EmployeeEmployeeByPageUpID
Public - Recruitment API
Hire API-Job
Get job by PageUp job ID / PUReferenceID (lJobID)Update job by PageUp job ID / PUReferenceID (lJobID)Get job position by PageUp job ID / PUReferenceID (lJobID)Search jobsCreate job
Hire API-Offer
Get offer by PageUp Offer ID (lOfferID)Update offer by PageUp Offer ID (lOfferID - Offer PUReferenceID)Get offer checks by PageUp Offer ID (lOfferID - Offer PUReferenceID)Get onboarding form and the answers by PageUp Offer ID (New Starter Form)Get offer/s by PageUp Application ID (lApplicationID)Create offer by PageUp Application ID (lApplicationID / Application - PUReferenceID)Get offer/s for review assigned to a PageUp user (By user email address)Search offers for active ApplicantsMark offers as processed based on a list of Application IDs (limited to max 100 application Ids per API request)Set offer status by PageUp Offer ID (lOfferID)Mark offers as processed by PageUp Offer ID (lOfferID)Reset offers as not processed by PageUp Offer ID (lOfferID)Set offer status by PageUp Application ID (lApplicationID)
Hire API-SearchApplications
Get applicant by PageUp Applicant ID (lApplicantID)Get application by PageUp Application ID (lApplicationID)Get application form and the answers by PageUp Application ID (lApplicationID)Search active applicationsSearch active applications by Job ID
Document API
Returns metadata about a specific documentReturns the URL of the document for download.Generate a Amazon S3 presigned URL for uploading a document toCreate new or update existing Document in the PageUp system with a newly uploaded file from Amazon S3 temp storage
Application API
Returns a single Application using the received application idAllows the update of an application's sFlagX string values, which are often used to store additional application data and shown in the Manage Applications page.Change an Application's ApplicationStatus (by the Status ID).Change an Application's ApplicationStatus (by the Status Code).Allows the changing of an application's order of merit (rank).Returns a list of applications associated with the specified Job IdCreates and returns a single Application using the received application jsonSubmits a single Application using the received application idReturns a list of applications associated with the specified applicant id
Public - Work Compliance API
UAT
GetInvitation- [UAT]AddStatus - [UAT]UpdateInvitation- [UAT]
PROD
GetInvitation- [PROD]AddStatus - [PROD]UpdateInvitation- [PROD]
obsolete - Application API
UAT
GetApplicationByApplicantID - [UAT]GetApplicationByApplicationID - [UAT]GetApplicationsByJobID - [UAT]CreateApplication - [UAT]ChangeApplicationByStatusCode - [UAT]
PROD
GetApplicationByApplicantID - [PROD]GetApplicationByApplicationID - [PROD]GetApplicationsByJobID - [PROD]CreateApplication - [PROD]ChangeApplicationByStatusCode - [PROD]
obsolete - Recruitment API
Applicant API
GetApplicantByApplicantID - [UAT]GetApplicantByApplicantID - [PROD]CreateApplicant - [UAT]CreateApplicant - [PROD]GetApplicantByEmail - [UAT]GetApplicantByEmail - [PROD]
Hire API-Job-UAT
GetJobByJobID - [UAT]GetJobPositionByPageUpJobID - [UAT]SearchJobs - [UAT]
Hire API-Job-PROD
GetJobByJobID - [PROD]GetJobPositionByPageUpJobID - [PROD]SearchJobs - [PROD]
Hire API-Offer-UAT
GetOfferByOfferID - [UAT]GetOfferChecksByOfferID - [UAT]GetOnboardingFormAnswersByOfferID - [UAT]SearchOffersForActiveApplicants - [UAT]
Hire API-Offer-PROD
GetOfferChecksByOfferID - [PROD]GetOnboardingFormAnswersByOfferID - [PROD]SearchOffersForActiveApplicants - [PROD]
Hire API-SearchApplications-UAT
GetApplicantByPageUpApplicantID - [UAT]SearchActiveApplications - [UAT]SearchActiveApplicationsByJobID - [UAT]GetApplicationFormAnswersByApplicationID - [UAT]
Hire API-SearchApplications-PROD
GetApplicantByPageUpApplicantID - [PROD]SearchActiveApplications - [PROD]SearchActiveApplicationsByJobID - [PROD]GetApplicationFormAnswersByApplicationID - [PROD]
Document API-UAT
GetDocumentMetadataByDocumentID - [UAT]GetDocumentDownloadURL - [UAT]PrepareTempDirectUpload - [UAT]MoveFromTemp - [UAT]
Document API-PROD
GetDocumentMetadataByDocumentID - [PROD]GetDocumentDownloadURL - [PROD]PrepareTempDirectUpload - [PROD]MoveFromTemp - [PROD]
Homeobsolete - Recruitment APIDocument API-UATGetDocumentDownloadURL - [UAT]

GetDocumentDownloadURL - [UAT]

GET https://apiuat.{{dataCenter}}.pageuppeople.com/v3/{{instID}}/recruitment/document/23948420/downloadurl

RESPONSES

status: OK

"https://xxxxx"
Previous
GetDocumentMetadataByDocumentID - [UAT]
Next
PrepareTempDirectUpload - [UAT]