ReferenceAPI referenceScopes

Scopes

Connections use groups

A connection or personal token reads the tables of the groups it has on, and nothing else. Each operation names its group. Prices, Contact details and Diversity details are switches on the token; money columns are blank unless Prices is on.

GroupTables
Workforce & sign-onsworkforce_log_v1, report_workforce_log_v1, report_sign_ons_v1, report_onsite_workers_v1, report_prestart_report_v1, report_inductions_export_v1, report_inductions_export_responses_v1
Alertsreport_alerts_report_v1, report_alerts_matrix_export_v1
Dockets & costsreport_dockets_export_v1, report_material_dockets_export_v1, report_subcontractor_dockets_export_v1, report_dayworks_report_v1, report_combined_report_v1, combined_report_data_v1, report_cost_allocation_v1
Diaries & activitiesreport_diary_export_v1, report_activities_report_v1, activity_log_data_v1
Issues & variationsreport_issues_export_v1, report_issues_variations_v1
Listsprojects, workers, sign_ons, member_fields

Custom access

A token that shows Custom access has no groups. It reaches only what its scopes allow.

ScopeAreaAllows
dockets:readDocketsView.
dockets:writeDocketsView and change.
dockets:adminDocketsNot available on tokens yet.
daywork:readDay WorksView.
daywork:writeDay WorksView and change.
daywork:adminDay WorksNot available on tokens yet.
diaries:readDiariesView.
diaries:writeDiariesView and change.
diaries:adminDiariesNot available on tokens yet.
prestarts:readPrestartsView.
prestarts:writePrestartsView and change.
prestarts:adminPrestartsNot available on tokens yet.
activities:readActivitiesView.
activities:writeActivitiesView and change.
activities:adminActivitiesNot available on tokens yet.
photos:readPhotosView.
photos:writePhotosView and change.
photos:adminPhotosNot available on tokens yet.
plants:readPlant RegisterView.
plants:writePlant RegisterView and change.
plants:adminPlant RegisterNot available on tokens yet.
issues:readIssues & VariationsView.
issues:writeIssues & VariationsView and change.
issues:adminIssues & VariationsNot available on tokens yet.
costcodes:readCost CodesView.
costcodes:writeCost CodesView and change.
costcodes:adminCost CodesNot available on tokens yet.
contracts:readContractsView.
contracts:writeContractsView and change.
contracts:adminContractsNot available on tokens yet.
suppliers:readSuppliersView.
suppliers:writeSuppliersView and change.
suppliers:adminSuppliersNot available on tokens yet.
clients:readClientsView.
clients:writeClientsView and change.
clients:adminClientsNot available on tokens yet.
materials:readMaterialsView.
materials:writeMaterialsView and change.
materials:adminMaterialsNot available on tokens yet.
fieldusers:readField UsersView.
fieldusers:writeField UsersView and change.
fieldusers:adminField UsersNot available on tokens yet.
users:readUsersView.
users:writeUsersView and change.
users:adminUsersNot available on tokens yet.
roles:readRoles & PermissionsView.
roles:writeRoles & PermissionsView and change.
roles:adminRoles & PermissionsNot available on tokens yet.
erp:readERP IntegrationsView.
erp:writeERP IntegrationsView and change.
erp:adminERP IntegrationsNot available on tokens yet.
reports:readReportsView.
reports:writeReportsView and change.
reports:adminReportsNot available on tokens yet.
projects:readProjectsView.
projects:writeProjectsView and change.
projects:adminProjectsNot available on tokens yet.
orgsettings:readOrg SettingsView.
orgsettings:writeOrg SettingsView and change.
orgsettings:adminOrg SettingsNot available on tokens yet.
businessunits:readBusiness UnitsView.
businessunits:writeBusiness UnitsView and change.
businessunits:adminBusiness UnitsNot available on tokens yet.
inductions:readInductionsView.
inductions:writeInductionsView and change.
inductions:adminInductionsNot available on tokens yet.
holidays:readHolidaysView.
holidays:writeHolidaysView and change.
holidays:adminHolidaysNot available on tokens yet.
reconciliation:readReconciliationView.
reconciliation:writeReconciliationView and change.
reconciliation:adminReconciliationNot available on tokens yet.
progressclaims:readProgress ClaimsView.
progressclaims:writeProgress ClaimsView and change.
progressclaims:adminProgress ClaimsNot available on tokens yet.
rollcall:readRoll CallView.
rollcall:writeRoll CallView and change.
rollcall:adminRoll CallNot available on tokens yet.
customfields:readCustom FieldsView.
customfields:writeCustom FieldsView and change.
customfields:adminCustom FieldsNot available on tokens yet.
workerassignment:readWorker AssignmentsView.
workerassignment:writeWorker AssignmentsView and change.
workerassignment:adminWorker AssignmentsNot available on tokens yet.
paymentmethods:readPayment MethodsView.
paymentmethods:writePayment MethodsView and change.
paymentmethods:adminPayment MethodsNot available on tokens yet.
alerts:readAlertsView.
alerts:writeAlertsView and change.
alerts:adminAlertsNot available on tokens yet.
locations:readProject LocationsView.
locations:writeProject LocationsView and change.
locations:adminProject LocationsNot available on tokens yet.
qr:readQR ManagerView.
qr:writeQR ManagerView and change.
qr:adminQR ManagerNot available on tokens yet.
drugalcohol:readDrug & AlcoholView.
drugalcohol:writeDrug & AlcoholView and change.
drugalcohol:adminDrug & AlcoholNot available on tokens yet.
signons:readSign On WorkbenchView.
signons:writeSign On WorkbenchView and change.
signons:adminSign On WorkbenchNot available on tokens yet.
copilot:readCopilotView.
copilot:writeCopilotView and change.
copilot:adminCopilotNot available on tokens yet.
personal:contactContact detailsFills in email, phone and address fields.
personal:diversityDiversity detailsFills in diversity fields.