Skip to main content
Each endpoint, except those related to OAuth 2, requires at least one scope for authorization. Below is the full list of available scopes.
ScopeNameDescription
public.access_token:readAccess Token (Read)Allow to read all access tokens
public.application:readApplication (Read)Allow to read all applications
public.contact:readContact (Read)Allow to read all contacts
public.contact:writeContact (Write)Allow to manage contacts
public.contract:readContract (Read)Allow to read all contracts
public.contract_template:readContract Template (Read)Allow to read all contract templates
public.coupon:readCoupon (Read)Allow to read all coupons
public.credit_note:readCredit Note (Read)Allow to read all credit notes
public.deal:readDeal (Read)Allow to read all deals
public.deal:writeDeal (Write)Allow to manage deals
public.deal_stage:readDeal Stage (Read)Allow to read all deal stages
public.identity_verification:readIdentity Verification (Read)Allow to read all identity verifications
public.invoice:readInvoice (Read)Allow to read all invoices
public.note:readNote (Read)Allow to read all notes
public.note:writeNote (Write)Allow to manage notes
public.order:readOrder (Read)Allow to read all orders
public.order:writeOrder (Write)Allow to manage orders
public.product:readProduct (Read)Allow to read all products
public.product:writeProduct (Write)Allow to manage products
public.product_category:readProduct Category (Read)Allow to read all product categories
public.protection_level:readProtection Level (Read)Allow to read all protection levels
public.protection_level:writeProtection Level (Write)Allow to manage protection levels
public.site:readSite (Read)Allow to read all sites
public.staff:readStaff (Read)Allow to read all staff
public.subscription:readSubscription (Read)Allow to read all subscriptions
public.task:readTask (Read)Allow to read all tasks
public.task:writeTask (Write)Allow to manage tasks
public.tenancy:readTenancy (Read)Allow to read all tenancies
public.timeline_event:readTimeline Event (Read)Allow to read all timeline events
public.timeline_event:writeTimeline Event (Write)Allow to manage timeline events
public.timeline_source:readTimeline Source (Read)Allow to read all timeline sources
public.timeline_template:readTimeline Template (Read)Allow to read all timeline templates
public.unit:readUnit (Read)Allow to read all units
public.unit:writeUnit (Write)Allow to manage units
public.unit_allocation:readUnit Allocation (Read)Allow to read all unit allocations
public.unit_type:readUnit Type (Read)Allow to read all unit types
public.unit_type:writeUnit Type (Write)Allow to manage unit types
public.webhook_endpoint:readWebhook Endpoint (Read)Allow to read all webhook endpoints
public.webhook_endpoint:writeWebhook Endpoint (Write)Allow to manage webhook endpoints