Puzzle OAuth Scopes

generated: '2026-07-20'
method: searched
source: https://puzzle-api.readme.io/docs/scopes
docs: https://puzzle-api.readme.io/docs/scopes
schemes:
- name: OAuth2
  flow: authorizationCode
  pkce: true
  authorizationUrl: https://api.puzzle.io/oauth/authorize
  tokenUrl: https://api.puzzle.io/oauth/token
default_scopes: [offline_access, read:company]
notes: >-
  Scopes are requested at /oauth/authorize. If no scopes are provided, the read-only
  scopes (offline_access, read:company) are used by default. Scopes are documented in
  the developer docs; the OpenAPI document itself does not declare oauth2 securitySchemes,
  so these were captured from the scopes reference page.
scopes:
- {scope: 'read:company', description: Grants read-only access to company data.}
- {scope: 'write:company', description: Allows creating or updating company info.}
- {scope: 'write:account', description: Allows creating financial accounts.}
- {scope: 'write:transaction', description: Allows creating transactions.}
- {scope: 'write:account_balance', description: Allows creating financial account balances.}
- {scope: 'write:benefit', description: Allows creating company benefit policies.}
- {scope: 'write:department', description: Allows creating departments.}
- {scope: 'write:location', description: Allows creating office locations.}
- {scope: 'write:worker', description: Allows creating employees and contractors.}
- {scope: 'write:payroll', description: Allows creating payrolls.}
- {scope: 'write:journal', description: Allows creating and updating journal entries.}
- {scope: 'write:bill', description: Allows creating bills.}
- {scope: 'write:customer', description: Allows creating customers.}
- {scope: 'write:integration_connection', description: Allows creating integration connections.}
- {scope: 'write:invoice', description: Allows creating invoices.}
- {scope: 'write:product', description: Allows creating products.}
- {scope: 'write:request', description: Allows creating requests.}
- {scope: 'write:task', description: Allows creating tasks.}
- {scope: 'write:vendor', description: Allows creating vendors.}
- {scope: 'write:classification', description: Allows creating classifications.}
- {scope: 'offline_access', description: Allows obtaining a refresh token for long-lived access.}