Skip to main content

Authorization and Scopes

Scope checks are enforced per endpoint.

Available Scopes

ScopeCompany keysAgency keysCovers
read:companiesYesYescompany list; company-scoped keys also cover company detail, regions, sectors, competency matrix, and connected agencies
read:tradesYesNotrades and trade detail
read:ratesYesYesstandalone rates
read:projectsYesNoprojects and project connected agencies
read:workersYesYesworkers and worker document detail
read:purchase-ordersYesNopurchase orders
read:sitesYesYessite access, including agency access where permitted
read:requisitionsYesYesrequisitions
read:assignmentsYesYesassignments
read:timesheetsYesYestimesheets and expenses
read:invoicesYesYesinvoices, AfP, and payment notices
read:credit-notesYesYescredit notes

No broad super-key behavior is granted by default.