Scopes

Scoping is a mechanism in OAuth 2.0 to limit an application’s access to the portal of a MijnKlantportaal user. When asking the user for permission to access his/her portal, you have to provide the areas/data (scopes) you want to get access to, as well if you want just to read the data (*.read) or also be able to create, delete and/or make changes to it (*.write).

Available scopes

Scope	Description
`agreements.read`	Getting the agreements and the documents related to it.
`agreements.write`	Creating and deleting agreements
`appointments.read`	Getting the appointments, both planned as pending records
`appointments.write`	Scheduling, changing, and canceling appointments
`businessoperations.read`	Getting the invoices sent to the user from MijnKlantportaal
`customers.read`	Getting the customers, and their data, and customer groups
`customers.write`	Creating, editing and deleting customers and customer groups
`files.read`	Getting files and be able to download them
`files.write`	Uploading and deleting files
`filerequest.read`	Getting file requests and the records of delivered files (not able to download)
`filerequest.write`	Creating and deleting file requests
`fileshare.read`	Getting the file share records and so see what files have been shared
`fileshare.write`	Sharing existing files with customers or via a public link
`offers.read`	Getting the offers in MijnKlantportaal and the PDF of it
`offers.write`	Being able to create new offers and/or upload new offer PDFs for customers, as well marking existing once accepted or declined
`invoices.read`	Getting the invoices in MijnKlantportaal and the PDF of it
`paymentlinks.read`	Getting the payment links and it’s corresponding payments
`paymentlinks.write`	Creating new payment links and being able to close existing once
`subscription.read`	Getting the subscriptions in MijnKlantportaal
`subscription.write`	Creating, editing and deleting subscriptions in MijnKlantportaal
`tickets.read`	Getting and reading support tickets
`tickets.write`	Being able to respond to support tickets and close them (marking as done)
`webhooks.read`	Listing and getting the webhooks which are created and set up
`webhooks.write`	Creating new webhooks and being able to delete existing once

Getting started

AI

OAuth

CMS

Available scopes

​Available scopes

Available scopes