Query

Object

additionalUsersPage

Fetch a page of additional users associated with a parent user. The parent user ID is optional; if omitted, the query will return users related to the currently authenticated user.

aiPrompt

Read AI Prompt by identifier

aiPromptAccessPolicy

Read AI Prompt Access Policy by identifier

aiPromptAccessPolicyPage

Read page of AI Prompt Access Policies

aiPromptPage

Read page of AI Prompts

candidate

Read candidate by id

candidatePage

Read page of candidates

company

Read company by id

companyPage

Read page of companies

contact

Read contact by id

contactPage

Read page of contacts

crAgency

Read CRAgency by id

crAgencyAttachment

Read CRAgencyAttachment by id

crAgencyAttachmentPage

Read page of CRAgencyAttachment

crAgencyPage

Read page of CRAgency

crArticle

Read CRArticle by id

crArticleAttachment

Read CRArticleAttachment by id

crArticleAttachmentPage

Read page of CRArticleAttachment

crArticlePage

Read page of CRArticle

crAttachment

Read CRAttachment by id

crAttachmentData

Read CRAttachmentData by id

crAttachmentDataPage

Read page of CRAttachmentData

crAttachmentForCRAgencyBy

Read CRAttachment for CRAgency

crAttachmentForCRArticleBy

Read CRAttachment for CRArticle

crAttachmentForCRCompanyBy

Read CRAttachment for CRCompany

crAttachmentForCREmailTemplateBy

Read CRAttachment for CREmailTemplate

crAttachmentForCREmployeeBy

Read CRAttachment for CREmployee

crAttachmentForCRInvoiceBy

Read CRAttachment for CRInvoice

crAttachmentForCRInvoiceLineBy

Read CRAttachment for CRInvoiceLine

crAttachmentForCRJobBy

Read CRAttachment for CRJob

crAttachmentForCRLeadBy

Read CRAttachment for CRLead

crAttachmentForCRMatchBy

Read CRAttachment for CRMatch

crAttachmentForCRMonthHourJobViewBy

Read CRAttachment for CRMonthHourJobView

crAttachmentForCRMonthHourViewBy

Read CRAttachment for CRMonthHourView

crAttachmentForCROpportunityBy

Read CRAttachment for CROpportunity

crAttachmentForCRPublicationBy

Read CRAttachment for CRPublication

crAttachmentForCRPurchaseInvoiceBy

Read CRAttachment for CRPurchaseInvoice

crAttachmentForCRResourceBy

Read CRAttachment for CRResource

crAttachmentForCRToDoBy

Read CRAttachment for CRToDo

crAttachmentForCRUserBy

Read CRAttachment for CRUser

crAttachmentForCRVacancyBy

Read CRAttachment for CRVacancy

crAttachmentForCRWeekHourViewBy

Read CRAttachment for CRWeekHourView

crAttachmentPage

Read page of CRAttachment

crAttachmentView

Read CRAttachmentView by id

crAttachmentViewPage

Read page of CRAttachmentView

crAttachmentWord

Read CRAttachmentWord by id

crAttachmentWordPage

Read page of CRAttachmentWord

crAttendeePage

crAttributeChange

Read CRAttributeChange by id

crAttributeChangePage

Read page of CRAttributeChange

crCompany

Read CRCompany by id

crCompanyAlias

Read CRCompanyAlias by id

crCompanyAliasPage

Read page of CRCompanyAlias

crCompanyAttachment

Read CRCompanyAttachment by id

crCompanyAttachmentPage

Read page of CRCompanyAttachment

crCompanyGroup

Read CRCompanyGroup by id

crCompanyGroupPage

Read page of CRCompanyGroup

crCompanyLink

Read CRCompanyLink by id

crCompanyLinkPage

Read page of CRCompanyLink

crCompanyPage

Read page of CRCompany

crCompanyStatus

Read CRCompanyStatus by id

crCompanyStatusPage

Read page of CRCompanyStatus

crConfig

Read CRConfig by id

crConfigPage

Read page of CRConfig

crConfigProfile

Read CRConfigProfile by id

crConfigProfilePage

Read page of CRConfigProfile

crContact

Read CRContact by id

crContactPage

Read page of CRContact

crData

Read CRData by id

crDataLink

Read CRDataLink by id

crDataLinkPage

Read page of CRDataLink

crDataNode

Read CRDataNode by id

crDataNodeListBy

Read CRDataNode list

crDataNodePage

Read page of CRDataNode

crDataNodeValue

Read CRDataNodeValue by id

crDataNodeValuePage

Read page of CRDataNodeValue

crDataPage

Read page of CRData

crEditionArticle

Read CREditionArticle by id

crEditionArticlePage

Read page of CREditionArticle

crEmail

Read CREmail by id

crEmailAddress

Read CREmailAddress by id

crEmailAddressPage

Read page of CREmailAddress

crEmailPage

Read page of CREmail

crEmailRanking

Read CREmailRanking by id

crEmailRankingPage

Read page of CREmailRanking

crEmailTemplate

Read CREmailTemplate by id

crEmailTemplateAttachment

Read CREmailTemplateAttachment by id

crEmailTemplateAttachmentPage

Read page of CREmailTemplateAttachment

crEmailTemplatePage

Read page of CREmailTemplate

crEmployee

Read CREmployee by id

crEmployeeAttachment

Read CREmployeeAttachment by id

crEmployeeAttachmentPage

Read page of CREmployeeAttachment

crEmployeeDocument

Read CREmployeeDocument by id

crEmployeeDocumentPage

Read page of CREmployeeDocument

crEmployeeEducation

Read CREmployeeEducation by id

crEmployeeEducationPage

Read page of CREmployeeEducation

crEmployeeFinance

Read CREmployeeFinance by id

crEmployeeFinancePage

Read page of CREmployeeFinance

crEmployeeFunctionNode

Read CREmployeeFunctionNode by id

crEmployeeFunctionNodePage

Read page of CREmployeeFunctionNode

crEmployeeLanguage

Read CREmployeeLanguage by id

crEmployeeLanguagePage

Read page of CREmployeeLanguage

crEmployeePage

Read page of CREmployee

crEmployeeSkill

Read CREmployeeSkill by id

crEmployeeSkillPage

Read page of CREmployeeSkill

crEmployeeTraining

Read CREmployeeTraining by id

crEmployeeTrainingPage

Read page of CREmployeeTraining

crFetchSpecification

Read CRFetchSpecification by id

crFetchSpecificationPage

Read page of CRFetchSpecification

crFinance

Read CRFinance by id

crFinancePage

Read page of CRFinance

crHour

Read CRHour by id

crHourPage

Read page of CRHour

crInvoice

Read CRInvoice by id

crInvoiceAttachment

Read CRInvoiceAttachment by id

crInvoiceAttachmentPage

Read page of CRInvoiceAttachment

crInvoiceLine

Read CRInvoiceLine by id

crInvoiceLineAttachment

Read CRInvoiceLineAttachment by id

crInvoiceLineAttachmentPage

Read page of CRInvoiceLineAttachment

crInvoiceLinePage

Read page of CRInvoiceLine

crInvoicePage

Read page of CRInvoice

crJob

Read CRJob by id

crJobAttachment

Read CRJobAttachment by id

crJobAttachmentPage

Read page of CRJobAttachment

crJobDocument

Read CRJobDocument by id

crJobDocumentPage

Read page of CRJobDocument

crJobFinance

Read CRJobFinance by id

crJobFinancePage

Read page of CRJobFinance

crJobGroup

Read CRJobGroup by id

crJobGroupPage

Read page of CRJobGroup

crJobPage

Read page of CRJob

crLead

Read CRLead by id

crLeadAttachment

Read CRLeadAttachment by id

crLeadAttachmentPage

Read page of CRLeadAttachment

crLeadGroup

Read CRLeadGroup by id

crLeadGroupPage

Read page of CRLeadGroup

crLeadPage

Read page of CRLead

crLeadStage

Read CRLeadStage by id

crLeadStageEmailTemplate

Read CRLeadStageEmailTemplate by id

crLeadStageEmailTemplatePage

Read page of CRLeadStageEmailTemplate

crLeadStageLink

Read CRLeadStageLink by id

crLeadStageLinkPage

Read page of CRLeadStageLink

crLeadStageName

Read CRLeadStageName by id

crLeadStageNamePage

Read page of CRLeadStageName

crLeadStagePage

Read page of CRLeadStage

crLeadStageTemplateReference

Read CRLeadStageTemplateReference by id

crLeadStageTemplateReferencePage

Read page of CRLeadStageTemplateReference

crLeadUser

Read CRLeadUser by id

crLeadUserPage

Read page of CRLeadUser

crMatch

Read CRMatch by id

crMatchAttachment

Read CRMatchAttachment by id

crMatchAttachmentPage

Read page of CRMatchAttachment

crMatchCriteria

Read CRMatchCriteria by id

crMatchCriteriaPage

Read page of CRMatchCriteria

crMatchGroup

Read CRMatchGroup by id

crMatchGroupPage

Read page of CRMatchGroup

crMatchPage

Read page of CRMatch

crMedium

Read CRMedium by id

crMediumPage

Read page of CRMedium

crMeeting

Read CRMeeting by id

crMeetingPage

Read page of CRMeeting

crMonthHourJobView

Read CRMonthHourJobView by id

crMonthHourJobViewPage

Read page of CRMonthHourJobView

crMonthHourView

Read CRMonthHourView by id

crMonthHourViewAttachment

Read CRMonthHourViewAttachment by id

crMonthHourViewAttachmentPage

Read page of CRMonthHourViewAttachment

crMonthHourViewPage

Read page of CRMonthHourView

crNodeRelationship

Read CRNodeRelationship by id

crNodeRelationshipPage

Read page of CRNodeRelationship

crNodeType

Read CRNodeType by id

crNodeTypePage

Read page of CRNodeType

crNote

Read CRNote by id

crNotePage

Read page of CRNote

crObjectAttachment

Read CRObjectAttachment by id

crObjectAttachmentPage

Read page of CRObjectAttachment

crObjectCheckpoint

Read CRObjectCheckpoint by id

crObjectCheckpointPage

Read page of CRObjectCheckpoint

crObjectImport

Read CRObjectImport by id

crObjectImportPage

Read page of CRObjectImport

crOpportunity

Read CROpportunity by id

crOpportunityAttachment

Read CROpportunityAttachment by id

crOpportunityAttachmentPage

Read page of CROpportunityAttachment

crOpportunityGroup

Read CROpportunityGroup by id

crOpportunityGroupPage

Read page of CROpportunityGroup

crOpportunityPage

Read page of CROpportunity

crOpportunityStage

Read CROpportunityStage by id

crOpportunityStageEmailTemplate

Read CROpportunityStageEmailTemplate by id

crOpportunityStageEmailTemplatePage

Read page of CROpportunityStageEmailTemplate

crOpportunityStageLink

Read CROpportunityStageLink by id

crOpportunityStageLinkPage

Read page of CROpportunityStageLink

crOpportunityStageName

Read CROpportunityStageName by id

crOpportunityStageNamePage

Read page of CROpportunityStageName

crOpportunityStagePage

Read page of CROpportunityStage

crOpportunityStageTemplateReference

Read CROpportunityStageTemplateReference by id

crOpportunityStageTemplateReferencePage

Read page of CROpportunityStageTemplateReference

crOpportunityUser

Read CROpportunityUser by id

crOpportunityUserPage

Read page of CROpportunityUser

crPhoneNumber

Read CRPhoneNumber by id

crPhoneNumberPage

Read page of CRPhoneNumber

crPosting

Read CRPosting by id

crPostingPage

Read page of CRPosting

crProformaBill

Read CRProformaBill by id

crProformaBillPage

Read page of CRProformaBill

crPublication

Read CRPublication by id

crPublicationAttachment

Read CRPublicationAttachment by id

crPublicationAttachmentPage

Read page of CRPublicationAttachment

crPublicationMedium

Read CRPublicationMedium by id

crPublicationMediumPage

Read page of CRPublicationMedium

crPublicationPage

Read page of CRPublication

crPublicationPageBy

Read page of CRPublication

crPurchaseInvoice

Read CRPurchaseInvoice by id

crPurchaseInvoiceAttachment

Read CRPurchaseInvoiceAttachment by id

crPurchaseInvoiceAttachmentPage

Read page of CRPurchaseInvoiceAttachment

crPurchaseInvoiceInvoiceLine

Read CRPurchaseInvoiceInvoiceLine by id

crPurchaseInvoiceInvoiceLinePage

Read page of CRPurchaseInvoiceInvoiceLine

crPurchaseInvoicePage

Read page of CRPurchaseInvoice

crQuickSearch

Read CRQuickSearch by id

crQuickSearchPage

Read page of CRQuickSearch

crResource

Read CRResource by id

crResourceAttachment

Read CRResourceAttachment by id

crResourceAttachmentPage

Read page of CRResourceAttachment

crResourcePage

Read page of CRResource

crSettings

crStatusInfo

Read CRStatusInfo by id

crStatusInfoEmailTemplates

Read CRStatusInfoEmailTemplates by id

crStatusInfoEmailTemplatesPage

Read page of CRStatusInfoEmailTemplates

crStatusInfoLink

Read CRStatusInfoLink by id

crStatusInfoLinkPage

Read page of CRStatusInfoLink

crStatusInfoName

Read CRStatusInfoName by id

crStatusInfoNamePage

Read page of CRStatusInfoName

crStatusInfoPage

Read page of CRStatusInfo

crStatusInfoTemplateReferences

Read CRStatusInfoTemplateReferences by id

crStatusInfoTemplateReferencesPage

Read page of CRStatusInfoTemplateReferences

crTalentPool

Read CRTalentPool by id

crTalentPoolCompany

Read CRTalentPoolCompany by id

crTalentPoolCompanyPage

Read page of CRTalentPoolCompany

crTalentPoolGroup

Read CRTalentPoolGroup by id

crTalentPoolGroupPage

Read page of CRTalentPoolGroup

crTalentPoolMatch

Read CRTalentPoolMatch by id

crTalentPoolMatchGroup

Read CRTalentPoolMatchGroup by id

crTalentPoolMatchGroupPage

Read page of CRTalentPoolMatchGroup

crTalentPoolMatchPage

Read page of CRTalentPoolMatch

crTalentPoolMatchStage

Read CRTalentPoolMatchStage by id

crTalentPoolMatchStageEmailTemplate

Read CRTalentPoolMatchStageEmailTemplate by id

crTalentPoolMatchStageEmailTemplatePage

Read page of CRTalentPoolMatchStageEmailTemplate

crTalentPoolMatchStageLink

Read CRTalentPoolMatchStageLink by id

crTalentPoolMatchStageLinkPage

Read page of CRTalentPoolMatchStageLink

crTalentPoolMatchStageName

Read CRTalentPoolMatchStageName by id

crTalentPoolMatchStageNamePage

Read page of CRTalentPoolMatchStageName

crTalentPoolMatchStagePage

Read page of CRTalentPoolMatchStage

crTalentPoolMatchStageTemplateReference

Read CRTalentPoolMatchStageTemplateReference by id

crTalentPoolMatchStageTemplateReferencePage

Read page of CRTalentPoolMatchStageTemplateReference

crTalentPoolPage

Read page of CRTalentPool

crTalentPoolUser

Read CRTalentPoolUser by id

crTalentPoolUserPage

Read page of CRTalentPoolUser

crTask

Read CRTask by id

crTaskPage

Read page of CRTask

crTemplatePart

Read CRTemplatePart by id

crTemplatePartLink

Read CRTemplatePartLink by id

crTemplatePartLinkPage

Read page of CRTemplatePartLink

crTemplatePartPage

Read page of CRTemplatePart

crTemplateReference

Read CRTemplateReference by id

crTemplateReferencePage

Read page of CRTemplateReference

crToDo

Read CRToDo by id

crToDoAttachment

Read CRToDoAttachment by id

crToDoAttachmentPage

Read page of CRToDoAttachment

crToDoNotes

Read CRToDoNotes by id

crToDoNotesPage

Read page of CRToDoNotes

crToDoPage

Read page of CRToDo

crToDoResource

Read CRToDoResource by id

crToDoResourcePage

Read page of CRToDoResource

crToDoSentContactView

Read CRToDoSentContactView by id

crToDoSentContactViewPage

Read page of CRToDoSentContactView

crToDoSentEmployeeView

Read CRToDoSentEmployeeView by id

crToDoSentEmployeeViewPage

Read page of CRToDoSentEmployeeView

crToDoUser

Read CRToDoUser by id

crToDoUserPage

Read page of CRToDoUser

crTrigger

Read CRTrigger by id

crTriggerPage

Read page of CRTrigger

crUrl

Read CRUrl by id

crUrlPage

Read page of CRUrl

crUser

Read CRUser by id

crUserAttachment

Read CRUserAttachment by id

crUserAttachmentPage

Read page of CRUserAttachment

crUserCompany

Read CRUserCompany by id

crUserCompanyPage

Read page of CRUserCompany

crUserGroup

Read CRUserGroup by id

crUserGroupPage

Read page of CRUserGroup

crUserHash

Read CRUserHash by id

crUserHashPage

Read page of CRUserHash

crUserPage

Read page of CRUser

crUserRole

Read CRUserRole by id

crUserRoleKey

Read CRUserRoleKey by id

crUserRoleKeyPage

Read page of CRUserRoleKey

crUserRolePage

Read page of CRUserRole

crUserStatus

Read CRUserStatus by id

crUserStatusPage

Read page of CRUserStatus

crVacancy

Read CRVacancy by id

crVacancyAttachment

Read CRVacancyAttachment by id

crVacancyAttachmentPage

Read page of CRVacancyAttachment

crVacancyCompanyUserView

Read CRVacancyCompanyUserView by id

crVacancyCompanyUserViewPage

Read page of CRVacancyCompanyUserView

crVacancyEducation

Read CRVacancyEducation by id

crVacancyEducationPage

Read page of CRVacancyEducation

crVacancyFunctionNode

Read CRVacancyFunctionNode by id

crVacancyFunctionNodePage

Read page of CRVacancyFunctionNode

crVacancyGroup

Read CRVacancyGroup by id

crVacancyGroupPage

Read page of CRVacancyGroup

crVacancyLanguage

Read CRVacancyLanguage by id

crVacancyLanguagePage

Read page of CRVacancyLanguage

crVacancyPage

Read page of CRVacancy

crVacancySkill

Read CRVacancySkill by id

crVacancySkillPage

Read page of CRVacancySkill

crVacancyTraining

Read CRVacancyTraining by id

crVacancyTrainingPage

Read page of CRVacancyTraining

crVacancyUser

Read CRVacancyUser by id

crVacancyUserPage

Read page of CRVacancyUser

crWeekHour

Read CRWeekHour by id

crWeekHourComment

Read CRWeekHourComment by id

crWeekHourCommentPage

Read page of CRWeekHourComment

crWeekHourJobView

Read CRWeekHourJobView by id

crWeekHourJobViewPage

Read page of CRWeekHourJobView

crWeekHourPage

Read page of CRWeekHour

crWeekHourView

Read CRWeekHourView by id

crWeekHourViewAttachment

Read CRWeekHourViewAttachment by id

crWeekHourViewAttachmentPage

Read page of CRWeekHourViewAttachment

crWeekHourViewPage

Read page of CRWeekHourView

crWorkHistory

Read CRWorkHistory by id

crWorkHistoryPage

Read page of CRWorkHistory

feature

Retrieve a Feature by id.

featureHistoryRecordPage

Retrieve a page of FeatureHistoryRecords.

featurePage

Retrieve a page of Features.

identityProvider

Retrieve an identity provider by any of it's unique identifiers: technical _id or human-readable alias .

identityProviderPage

Retrieve a page of identity providers configured for a tenant.

lead

Read lead by id

leadPage

Read page of leads

manifest

Retrieve a Manifest by id.

manifestPage

Retrieve a page of Manifests.

match

Read match by id

matchPage

Read page of matches

oAuth2Client

Retrieve an OAuth2 client by any of it's unique identifiers: technical _id , human-readable code or OAuth2 client ID from credentials.clientId .

oAuth2ClientPage

Retrieve a page of OAuth2 clients.

oAuth2ScopePage

Retrieve a page of OAuth2 scopes available for a tenant.

officeEmployee

Read office employee by id

officeEmployeePage

Read page of office employees

opportunity

Read opportunity by id

opportunityPage

Read page of opportunities

permissionsEvaluate

Evaluates a list of permissions available for a user. The less permissions are to be checked - the better will be a response time. API Services are encouraged to either do a check for a single permission or calculate a permission for a single operation.

piDashboard

Fetch single of Dashboard

piDashboardPage

Fetch page of Dashboards

placement

Read placement by id

placementPage

Read page of placements

reference

Read Contact, Candidate or OfficeEmployee

resourcePage

Fetch a page of resources.

resourceRolePage

Fetch a page of resource roles.

role

Fetch a single role by its ID.

rolePage

Fetch a page of roles with optional filtering. The attributes that can be used for filtering include 'active' and 'assignableToAdditionalUsers'. For example, filters can be applied as 'active eq true' or 'assignableToAdditionalUsers eq false'.

talentpool

Read talentpool by id

talentpoolPage

Read page of talentpools

tenant

Retrieve configuration of current tenant.

transcript

Retrieve a Transcript by it's unique identifier.

transcriptPage

Retrieve a page of Transcripts.

user

Fetch a single user by their ID.

userPage

Fetch a page of users.

vacancy

Read vacancy by id

vacancyPage

Read page of vacancies