API reference
1633 operations across 415 resources, generated from the OpenAPI document version 1.0.0-draft.2. OpenAPI document
Home
Org dashboard, my work, gate readiness and alerts (Section 4.2).
- home1 operations
Projects
Projects, scope tree, jurisdiction and gate evidence (Section 4.2).
- projects9 operations
- scopeNodes5 operations
- projectPhaseTransitions2 operations
- gateEvidence4 operations
- projectAuthorities1 operations
- measurementMetrics1 operations
- measurementUnits1 operations
- measurementMetricTags1 operations
- projectObjectives5 operations
- projectMeasurements5 operations
- projectMeasurementCorrections2 operations
- earnedMediaItems5 operations
- projectMeasurementSummary1 operations
Activity
The user-facing activity feed, separate from the audit ledger (Section 4.2).
- activityEvents2 operations
Schedule
Timeline records, baselines, dependencies, calendars and actuals (Section 4.2).
- scheduleBaselines4 operations
- scheduleActuals4 operations
- calendars5 operations
- recordDependencies4 operations
- recordRecurrences5 operations
Work
The record spine for all 26 kinds, and work orders with bids (Sections 3.10 and 4.2).
- records7 operations
- recordStateTransitions2 operations
- recordReplans2 operations
- recordChecklistItems5 operations
- recordWatchers3 operations
- workOrders6 operations
- workOrderBids5 operations
Show
Run of show, cues, day sheets and call sheets (Section 4.2).
- runsOfShow5 operations
- cues6 operations
- daySheets6 operations
- callSheets6 operations
- cueCalls5 operations
Knowledge
SOPs with acknowledgment, documents with versions and controlled vocabulary (Section 4.2).
- sops6 operations
- sopAcknowledgments3 operations
- documents5 operations
- documentVersions3 operations
- verbiageTerms5 operations
Places
Venues, spaces, zones, capability documents, site plans and reconciliation (Section 4.2).
- venues5 operations
- spaces5 operations
- zones5 operations
- capabilityDocuments6 operations
- sitePlans5 operations
- sitePlanPins5 operations
- geofences5 operations
- requirements5 operations
- reconciliations3 operations
- reconciliationLines2 operations
Logistics
Shipments, dock slots, gate queue, staging and release (Section 4.2).
- shipments5 operations
- shipmentLines5 operations
- dockSlots6 operations
- gateQueueEntries5 operations
- marshallingLogEntries3 operations
Advancing
Advance packets, sections, recipients, submissions and riders (Section 4.2).
- advancePackets6 operations
- advanceSections5 operations
- advanceRecipients4 operations
- advanceSubmissions4 operations
- advancePromotions3 operations
- riders5 operations
- riderLines5 operations
- guestListEntries7 operations
Hospitality
Lodging, catering, travel and amenity fulfillment and BEOs (Section 4.2).
- fulfillments6 operations
- fulfillmentLines5 operations
- beos5 operations
- beoLines5 operations
Assets
Assets at class, unit and lot grain, custody, maintenance and damage (Section 4.2).
- assetClasses5 operations
- assetUnits8 operations
- assetLots5 operations
- assetIdentifiers4 operations
- assetCustodyEntries3 operations
- assetMaintenanceEvents5 operations
- assetDamageReports5 operations
Opportunities
Opportunities, applications, selection, offers, onboarding, engagements, ratings and pools (Sections 4.2 and 4.4).
- opportunities6 operations
- opportunityPositions5 operations
- opportunityRequirements5 operations
- opportunityQuestions5 operations
- payTransparencyRules1 operations
- applications4 operations
- applicationAnswers3 operations
- bids4 operations
- bidLines5 operations
- agencySlates4 operations
- shortlistEntries5 operations
- interviews5 operations
- engagements4 operations
- engagementDocuments4 operations
- onboardingRequirements5 operations
- onboardingItems4 operations
- onboardingVerifications3 operations
- talentPools5 operations
- poolMembers5 operations
- ratings3 operations
- ratingReplies3 operations
People
Role assignments, requisitions, offers and agreements (Section 4.2).
- roleAssignments5 operations
- requisitions7 operations
- offers8 operations
- agreements5 operations
Crew
Shifts, swaps, time, timesheets, rate cards, pay rates and payroll export (Section 4.2).
- shifts8 operations
- shiftSwaps6 operations
- timeEntries4 operations
- timeEntryCorrections4 operations
- timeEntryAuditEntries2 operations
- timesheets5 operations
- timesheetApprovals2 operations
- kioskDevices5 operations
- rateCards5 operations
- rateCardLines5 operations
- payRates3 operations
- overtimeRules2 operations
- unionLocalRates5 operations
- wageDeterminations5 operations
- payPeriods5 operations
- payrollRuns6 operations
- payrollLines2 operations
- payrollExports3 operations
- earningCodes5 operations
- perDiems5 operations
- timeOffPolicies5 operations
- timeOffRequests5 operations
Credentials
Credential categories, issuance, the Access Grid and scans (Section 4.2).
- credentialCategories5 operations
- credentials4 operations
- accessGridEntries5 operations
- accessScans3 operations
- certifications5 operations
- certificationHolders5 operations
Finance
Budgets, expenses, change orders, ledger, periods and the Universal Posting Line (Sections 3.11 and 4.2).
- budgets6 operations
- budgetLines5 operations
- expenses6 operations
- contingencyDraws3 operations
- changeOrders6 operations
- changeOrderLines5 operations
- accountingPeriods4 operations
- journalEntries5 operations
- journalLines5 operations
- postingLines3 operations
- invoices7 operations
- invoiceLines5 operations
- paymentApplications3 operations
- billingDraws5 operations
- costCenters5 operations
- taxJurisdictions5 operations
- taxRates5 operations
- fxRates1 operations
- priceBooks5 operations
- form1099Nec1 operations
Procurement
RFQs, purchase orders, receipts, three-way match and catalog bindings (Section 4.2).
- rfqs7 operations
- rfqInvitations4 operations
- rfqResponses3 operations
- rfqResponseLines5 operations
- purchaseOrders7 operations
- poLines5 operations
- poChangeOrders6 operations
- goodsReceipts3 operations
- receiptLines3 operations
- invoiceMatches4 operations
- catalogBindings5 operations
- vendorProducts5 operations
Vendors
Vendors, classes, prequalification, insurance, scorecards and sponsor entitlements (Section 4.2).
- vendors6 operations
- vendorClasses5 operations
- vendorClassAssignments4 operations
- prequalifications6 operations
- insuranceCertificates5 operations
- vendorScorecards5 operations
- sponsorEntitlements7 operations
- insuranceCertificateInsureds5 operations
- requiredAdditionalInsureds5 operations
Safety
Inspections, the permit engine, incidents with dispatch, emergency codes and radio (Section 4.2).
- inspectionTemplates5 operations
- inspectionItems5 operations
- inspections5 operations
- inspectionResults4 operations
- permitRequirements5 operations
- incidents6 operations
- incidentParties5 operations
- incidentMediaItems4 operations
- dispatchAssignments4 operations
- medicalEncounters4 operations
- crisisAlerts4 operations
- emergencyCodes2 operations
- radioChannels5 operations
Canon
Read-only canon from `xpms`, cached by canon generation, and tenant extension proposals (Sections 4.2 and 7.2).
- canonDepartments2 operations
- canonDisciplines2 operations
- canonCategories2 operations
- canonActs2 operations
- canonPhases2 operations
- canonGateCriteria2 operations
- canonTiers2 operations
- canonTeams2 operations
- canonTags2 operations
- canonTouchpoints2 operations
- canonJurisdictions2 operations
- canonRegions2 operations
- canonRegionMultipliers2 operations
- canonEscalationIndices2 operations
- canonStalenessPolicies2 operations
- canonPermitRules2 operations
- canonMetrics2 operations
- canonIdentifierClasses2 operations
- canonGrains2 operations
- canonProvenances2 operations
- canonFacets2 operations
- canonAssertionRanks2 operations
- canonRecordKinds2 operations
- canonRecordSubtypes2 operations
- canonRecordStates2 operations
- canonRoles2 operations
- canonCounterpartyTypes2 operations
- canonGlAccounts2 operations
- canonCostCenterTemplates2 operations
- canonCategoryGl2 operations
- canonUnitAliases2 operations
- canonUnitDimensions2 operations
- canonUrnNamespaces2 operations
- canonLocales2 operations
- canonElements3 operations
- canonElementPriceBands1 operations
- canonElementGtins3 operations
- canonElementPhases1 operations
- canonElementTags1 operations
- canonElementPermits1 operations
- canonElementMetrics1 operations
- canonTouchpointDisciplines1 operations
- canonDisciplineTeams1 operations
- canonStdDocumentLibrary2 operations
- canonStdEmergencyCodes2 operations
- canonStdEnumerations2 operations
- canonStdLaborRateCards2 operations
- canonStdRadioChannels2 operations
- canonStdRoles2 operations
- canonStdSops2 operations
- canonStdVendorClasses2 operations
- canonStdVendorEntitlements2 operations
- canonStdVerbiage2 operations
- canonSupersessions1 operations
- canonRatifications2 operations
- canonVersions2 operations
- canonCoordinateMatrix1 operations
- canonPhaseCoverage1 operations
- canonElementEconomics1 operations
- canonCrosswalkCoverage1 operations
- canonUrns1 operations
- canonExtensions1 operations
- canonStdEmergencyProtocols2 operations
Reports
Report builder, dashboards, scheduled delivery and the built-in analytics reports (Sections 4.2 and 4.6.4).
- reportDefinitions5 operations
- reportRuns3 operations
- reportSchedules5 operations
- dashboards5 operations
- dashboardTiles5 operations
- reports6 operations
- reportScheduleRecipients4 operations
- reportDeliveries2 operations
Settings
Organization, access, security, white label, integrations, billing, data and privacy (Sections 4.2 and 8).
- subscriptions2 operations
- plans1 operations
- workspaces5 operations
- workspaceMembers4 operations
- teams5 operations
- teamMembers4 operations
- orgBrandings5 operations
- orgLegalEntities5 operations
- orgIpAllowlistEntries5 operations
- roles5 operations
- capabilities1 operations
- roleCapabilities4 operations
- userCapabilityGrants5 operations
- recordGrants5 operations
- delegations5 operations
- spendAuthorityLimits5 operations
- separationOfDutiesRules1 operations
- columnClassifications1 operations
- accessReviewCampaigns5 operations
- accessReviewItems3 operations
- breakGlassSessions4 operations
- projectShares5 operations
- scimGroupMappings5 operations
- apiKeys6 operations
- serviceAccounts5 operations
- oauthApps5 operations
- oauthGrants3 operations
- integrations8 operations
- webhookEndpoints5 operations
- webhookDeliveries3 operations
- webhookEventTypes1 operations
- settingDefinitions1 operations
- settingValues5 operations
- settingLocks4 operations
- auditEvents2 operations
- consentRecords3 operations
- dsarRequests3 operations
- retentionPolicies1 operations
- orgExports3 operations
- aiSettings4 operations
- aurora9 operations
- aiSuggestions6 operations
- aiRequests2 operations
- aiUsage1 operations
Gateway
External-party resources: marketplace, saved searches, profile shares, availability, messages, tax and payout details (Section 4.4).
- marketplace1 operations
- savedSearches5 operations
- opportunityAlerts2 operations
- listingReports3 operations
- moderationActions2 operations
- profileShares4 operations
- availabilityCalendars5 operations
- availabilityBlocks5 operations
- engagementThreads4 operations
- engagementMessages3 operations
- taxForms3 operations
- payoutAccounts4 operations
- backgroundChecks3 operations
Identity
People, organizations, memberships, assignments, representation and profiles (Section 4.8).
- me1 operations
- people3 operations
- organizations6 operations
- memberships5 operations
- membershipRoles4 operations
- projectAssignments5 operations
- projectAssignmentRoles4 operations
- accountMemberships4 operations
- accountMembershipRoles4 operations
- organizationRelationships5 operations
- representations5 operations
- joinRequests5 operations
- invitationLinks4 operations
- invites6 operations
- verifiedDomains6 operations
- offboardingChecklists3 operations
- personProfiles4 operations
- organizationProfiles4 operations
- profileVisibilityRules5 operations
- verifications2 operations
- blocks4 operations
- workDetails6 operations
- emergencyContacts5 operations
- loyaltyPrograms5 operations
- workDetailShares7 operations
- workDetailEvents1 operations
Platform
Custom objects, imports and exports, approvals, comments, notifications, saved views, trash and templates (Sections 4.6 and 4.10).
- customObjectTypes5 operations
- customObjectFields5 operations
- objects5 operations
- customObjectRelations4 operations
- customFieldDefinitions5 operations
- customFieldValues5 operations
- orgStateLabels5 operations
- importJobs5 operations
- importBatches3 operations
- importRowResults2 operations
- importMappingProfiles5 operations
- mergeReviews3 operations
- exportJobs3 operations
- savedViews5 operations
- approvalPolicies6 operations
- approvalInstances4 operations
- approvalDecisions3 operations
- commentThreads4 operations
- comments6 operations
- notifications5 operations
- notificationPreferences4 operations
- calendarFeeds5 operations
- trashItems2 operations
- templates6 operations
- templateApplications3 operations
- savedViewShares4 operations
- savedViewDefaults4 operations
- tourProgress4 operations
- tipDismissals4 operations
- supportTickets5 operations
- supportTicketMessages2 operations
- supportTicketDiagnostics2 operations
- approvalSteps5 operations
- templateVersions6 operations
- templateItems5 operations
- supportSessions4 operations
- wholesaleStatements3 operations
- ownershipTransfers6 operations
- orgDeletionRequests4 operations
- deletionCertificates2 operations
- partnerStandingGrants4 operations
- shareLinks4 operations
- personCalendarFeeds5 operations
- projectInboxes5 operations
- inboundMessages4 operations
- automations6 operations
- automationRuns5 operations
- automationRunSteps2 operations
Workforce
Groups, chat, the directory, the feed, polls, surveys, recognition, events, forms, training, the handbook, the help desk and site operations (Section 4.9).
- workforceGroups5 operations
- workforceGroupMembers4 operations
- conversations5 operations
- chatMessages5 operations
- directoryEntries1 operations
- feedPosts10 operations
- polls4 operations
- surveys6 operations
- surveyQuestions2 operations
- recognitions3 operations
- workforceEvents7 operations
- eventRsvps2 operations
- eventCheckIns2 operations
- formTemplates6 operations
- formSubmissions4 operations
- trainingCourses8 operations
- trainingLessons6 operations
- trainingQuizQuestions4 operations
- trainingQuizKeys4 operations
- trainingAssignments3 operations
- trainingCompletions3 operations
- handbookSections4 operations
- handbookArticles7 operations
- knowledgeSources1 operations
- helpDeskTeams5 operations
- helpDeskTeamMembers4 operations
- helpDeskRequests6 operations
- occupancyCounters5 operations
- weatherThresholds4 operations
- weatherAlertRoles4 operations
- weatherReadings3 operations
- weatherAlerts2 operations
- guestCheckIns4 operations
- lostFoundItems6 operations
- lostFoundClaims3 operations