Public - Assessment API

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]

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

Public - BackgroundCheck API

GetBackgroundCheckRequest UpdateBackgroundCheck

Public - Core HR API

Agreement Type API

Agreement Classification API

AgreementClassification

Business Unit API

BusinessUnitLevel1 BusinessUnitLevel2 BusinessUnitLevel3 BusinessUnitLevel4

Cost Centre API

Generic List API

Employee EmployeeByPageUpID

Public - Recruitment API

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 jobs Create job

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 Applicants Mark 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 applications Search active applications by Job ID

Returns metadata about a specific document Returns the URL of the document for download.Generate a Amazon S3 presigned URL for uploading a document to Create 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 id Allows 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 Id Creates and returns a single Application using the received application json Submits a single Application using the received application id Returns a list of applications associated with the specified applicant id

Public - Work Compliance API

GetInvitation- [UAT]AddStatus - [UAT]UpdateInvitation- [UAT]

GetInvitation- [PROD]AddStatus - [PROD]UpdateInvitation- [PROD]

obsolete - Application API

GetApplicationByApplicantID - [UAT]GetApplicationByApplicationID - [UAT]GetApplicationsByJobID - [UAT]CreateApplication - [UAT]ChangeApplicationByStatusCode - [UAT]

GetApplicationByApplicantID - [PROD]GetApplicationByApplicationID - [PROD]GetApplicationsByJobID - [PROD]CreateApplication - [PROD]ChangeApplicationByStatusCode - [PROD]

obsolete - Recruitment 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]

Public - Assessment API

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]

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

Public - BackgroundCheck API

GetBackgroundCheckRequest UpdateBackgroundCheck

Public - Core HR API

Agreement Type API

Agreement Classification API

AgreementClassification

Business Unit API

BusinessUnitLevel1 BusinessUnitLevel2 BusinessUnitLevel3 BusinessUnitLevel4

Cost Centre API

Generic List API

Employee EmployeeByPageUpID

Public - Recruitment API

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 jobs Create job

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 Applicants Mark 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 applications Search active applications by Job ID

Returns metadata about a specific document Returns the URL of the document for download.Generate a Amazon S3 presigned URL for uploading a document to Create 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 id Allows 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 Id Creates and returns a single Application using the received application json Submits a single Application using the received application id Returns a list of applications associated with the specified applicant id

Public - Work Compliance API

GetInvitation- [UAT]AddStatus - [UAT]UpdateInvitation- [UAT]

GetInvitation- [PROD]AddStatus - [PROD]UpdateInvitation- [PROD]

obsolete - Application API

GetApplicationByApplicantID - [UAT]GetApplicationByApplicationID - [UAT]GetApplicationsByJobID - [UAT]CreateApplication - [UAT]ChangeApplicationByStatusCode - [UAT]

GetApplicationByApplicantID - [PROD]GetApplicationByApplicationID - [PROD]GetApplicationsByJobID - [PROD]CreateApplication - [PROD]ChangeApplicationByStatusCode - [PROD]

obsolete - Recruitment 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]

Home Public - Core HR API Team APITeam

Team

PUT {{baseUrl}}/team

Request Body

{"externalId"=>"TEAM001", "title"=>"TestTEAM 001"}

RESPONSES

status: OK

&quot;&quot;