Magidoc

Query
Object

Fields

#

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

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

crAgencyAttachmentPage

Read page of CRAgencyAttachment

crArticleAttachmentPage

Read page of CRArticleAttachment

crAttachmentForCRAgencyBy

Read CRAttachment for CRAgency

crAttachmentForCRArticleBy

Read CRAttachment for CRArticle

crAttachmentForCREmailTemplateBy

Read CRAttachment for CREmailTemplate

crAttachmentForCRInvoiceBy

Read CRAttachment for CRInvoice

crAttachmentForCRInvoiceLineBy

Read CRAttachment for CRInvoiceLine

crAttachmentForCRLeadBy

Read CRAttachment for CRLead

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

crAttachmentForCRWeekHourViewBy

Read CRAttachment for CRWeekHourView

crDataNode

Read CRDataNode by id

crDataNodeListBy

Read CRDataNode list

crDataNodePage

Read page of CRDataNode

crDataNodeValue

Read CRDataNodeValue by id

crDataNodeValuePage

Read page of CRDataNodeValue

crEmailTemplateAttachment

Read CREmailTemplateAttachment by id

crEmailTemplateAttachmentPage

Read page of CREmailTemplateAttachment

crFetchSpecificationPage

Read page of CRFetchSpecification

crInvoiceAttachmentPage

Read page of CRInvoiceAttachment

crInvoiceLineAttachment

Read CRInvoiceLineAttachment by id

crInvoiceLineAttachmentPage

Read page of CRInvoiceLineAttachment

crLeadStageEmailTemplate

Read CRLeadStageEmailTemplate by id

crLeadStageEmailTemplatePage

Read page of CRLeadStageEmailTemplate

crLeadStageTemplateReference

Read CRLeadStageTemplateReference by id

crLeadStageTemplateReferencePage

Read page of CRLeadStageTemplateReference

crMonthHourJobViewPage

Read page of CRMonthHourJobView

crMonthHourViewAttachment

Read CRMonthHourViewAttachment by id

crMonthHourViewAttachmentPage

Read page of CRMonthHourViewAttachment

crNodeRelationshipPage

Read page of CRNodeRelationship

crObjectAttachmentPage

Read page of CRObjectAttachment

crObjectCheckpointPage

Read page of CRObjectCheckpoint

crOpportunityAttachment

Read CROpportunityAttachment by id

crOpportunityAttachmentPage

Read page of CROpportunityAttachment

crOpportunityGroupPage

Read page of CROpportunityGroup

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

crPublicationAttachment

Read CRPublicationAttachment by id

crPublicationAttachmentPage

Read page of CRPublicationAttachment

crPublicationMediumPage

Read page of CRPublicationMedium

crPurchaseInvoiceAttachment

Read CRPurchaseInvoiceAttachment by id

crPurchaseInvoiceAttachmentPage

Read page of CRPurchaseInvoiceAttachment

crPurchaseInvoiceInvoiceLine

Read CRPurchaseInvoiceInvoiceLine by id

crPurchaseInvoiceInvoiceLinePage

Read page of CRPurchaseInvoiceInvoiceLine

crResourceAttachmentPage

Read page of CRResourceAttachment

crStatusInfoEmailTemplates

Read CRStatusInfoEmailTemplates by id

crStatusInfoEmailTemplatesPage

Read page of CRStatusInfoEmailTemplates

crStatusInfoTemplateReferences

Read CRStatusInfoTemplateReferences by id

crStatusInfoTemplateReferencesPage

Read page of CRStatusInfoTemplateReferences

crTalentPoolCompanyPage

Read page of CRTalentPoolCompany

crTalentPoolMatchGroup

Read CRTalentPoolMatchGroup by id

crTalentPoolMatchGroupPage

Read page of CRTalentPoolMatchGroup

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

crTemplatePartLinkPage

Read page of CRTemplatePartLink

crTemplateReferencePage

Read page of CRTemplateReference

crToDoSentContactView

Read CRToDoSentContactView by id

crToDoSentContactViewPage

Read page of CRToDoSentContactView

crToDoSentEmployeeView

Read CRToDoSentEmployeeView by id

crToDoSentEmployeeViewPage

Read page of CRToDoSentEmployeeView

crWeekHourViewAttachment

Read CRWeekHourViewAttachment by id

crWeekHourViewAttachmentPage

Read page of CRWeekHourViewAttachment

event

eventPageByDateRange

eventPageByDateRangeAndEmail

eventPageByLinkedEntity

feature

Retrieve a Feature by id.

featureHistoryRecordPage

Retrieve a page of FeatureHistoryRecords.

featurePage

Retrieve a page of Features.

frontendSetting

Read setting

frontendSettingPage

Read page of settings

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.

user

Fetch a single user by their ID.

userPage

Fetch a page of users.

vacancy

Read vacancy by id

vacancyPage

Read page of vacancies