Permissions Reference

API tokens must be assigned permissions to access specific operations. Permissions are scoped to an organisation and are managed in the Integration Hub.

Tip

For security, always assign the minimum permissions required for your integration.

Booking permissions

Permission	Description	Used by
BookingObservation	View bookings (implicit for queries)	bookings, booking queries; REST bookings export
BookingParticipation	Participate in booking workflows	updateBookingStatus, updateBookingTasks, updateBookingDriver, updateBookingRequestedTime
BookingStatusOverride	Override a booking’s status	overrideBookingStatus
BookingTasksOverride	Override a booking’s tasks	overrideBookingTasks
BookingSpaceAssignment	Assign or change a booking’s space	assignBookingSpace
BookingLoadOverride	Override actual load quantities	setBookingActualLoad
BookingFieldsOverride	Override custom field values	setBookingFields
BookingDriverOverride	Override a booking’s driver	overrideBookingDriver
BookingVehicleOverride	Override a booking’s vehicle	overrideBookingVehicle
BookingHistoryOverride	Add historic status events	addHistoricBookingStatusEvent
BookingCarrierReassign	Reassign a booking’s carrier	reassignBookingCarrier
BookingTaskReassign	Reassign booking tasks	reassignBookingTasks
InstantBookingCreation	Create bookings instantly	createInstantBooking

Document permissions

Permission	Description	Used by
DocumentObservation	View documents	REST GET document endpoints
DocumentManagement	Create, update, and delete documents	REST PUT/DELETE document endpoints; batch jobs

Pass permissions

Permission	Description	Used by
PassManagement	Create, update, and delete passes and pass types	REST pass endpoints; GraphQL pass mutations

Organisation permissions

Permission	Description	Used by
OrganisationAdministration	Administer organisation settings and information	Organisation management mutations
OrganisationAnnouncements	Send email announcements to connected organisations	Announcement mutations
MembershipManagement	Manage organisation members and role assignments	Member invite/remove mutations
ConnectionManagement	Manage organisation connections and connection codes	Connection create/update/delete mutations
IntegrationManagement	Manage API integration tokens	Token management in the Integration Hub
ReportsObservation	View organisation reports	Report queries
ReportsManagement	Edit organisation reports	Report management mutations
DriverObservation	View bookings linked to a driver	Driver-scoped booking queries

Configuration permissions

Permission	Description	Used by
LocationConfiguration	Configure location settings, areas, spaces, vehicles, rules, statuses, fields	Many configuration mutations
RecurringBookingManagement	Manage recurring booking schedules	Recurring booking mutations

Yard asset permissions

Permission	Description	Used by
YardAssetObservation	View yard assets	Yard asset queries
YardAssetManagement	Create and manage yard assets	Yard asset CRUD mutations
YardAssetParticipation	Participate in yard asset workflows	Yard asset status update mutations

Job permissions

Permission	Description	Used by
JobObservation	View jobs	jobs, job queries
JobManagement	Create and manage jobs	Job CRUD mutations
JobParticipation	Participate in job workflows	Job status update mutations