The complete list of API-key scopes, grouped by module. A key can only do what its scopes allow.
Scopes are chosen when an API key is created and can't be widened afterward - mint a new key to change access. Most resources have a :read and a :write scope; a few are read-only by nature. The wildcard *:* grants everything.
:write covers create, update, and delete. A write scope without its read scope is rarely useful - grant them together.
Registry
Scope family
Read
Write
assets
✓
✓
sites / buildings / locations
✓
✓
systems (classes, groups, systems)
✓
✓
asset_types / asset_type_groups
✓
✓
asset_statuses
✓
✓
building_types / location_types
✓
✓
manufacturers
✓
✓
custom_fields
✓
✓
asset_placements
✓
✓
floorplans / floorplan_regions
✓
✓
Asset records
Scope family
Read
Write
asset_comments
✓
✓
asset_costs
✓
✓
asset_documents
✓
✓
asset_parts
✓
✓
asset_condition_assessments
✓
✓
asset_lifecycle_events
✓
✓
asset_betterments
✓
✓
asset_replacement_plans
✓
✓
asset_risk_history
✓
read-only
CMMS
Scope family
Read
Write
work_orders / work_order_comments
✓
✓
work_order_schedules
✓
✓
work_requests
✓
✓
work_categories
✓
✓
pm_schedules / pm_templates
✓
✓
form_templates / form_template_items
✓
✓
form_responses
✓
✓
form_response_answers
✓
read-only
parts / part_categories
✓
✓
vendors / vendor_site_assignments
✓
✓
contracts / contract_sites / contract_documents
✓
✓
compliance / compliance_records
✓
✓
Financials
Scope family
Read
Write
expenses
✓
✓
invoices
✓
✓
purchase_orders (also covers purchase-order-lines and purchase-order-links)