Scopes

Each key has scopes that say what it can do. Endpoints list the scope they need.

Scope	Allows
read_all	See every kind of record, now and as new ones are added. Changes nothing.
write_all	Read and change everything a key can, including webhooks.
organisation:read	See your business name, country and settings summary.
locations:read	List your locations and their details.
locations:write	Add, change and remove locations.
members:read	List the people in your team.
members:write	Invite people to your team as staff, and see or cancel the invitations the app sent. Only for installed apps, and only while you are on the Free plan or a trial.
items:read	List and read catalogue items.
items:write	Add, change and remove catalogue items, one at a time or in bulk.
leads:write	Send in new leads, for example from your website forms.
contacts:read	Read contacts and their details.
contacts:write	Add and change contacts.
contacts:delete	Delete a contact and all their data, for example to honour an erasure request. This cannot be undone.
companies:read	List and read companies, their people and their details.
companies:write	Add and change companies, merge them, and link people to them (with their role and job title).
companies:delete	Delete a company. Its people and their threads stay.
threads:read	List and read threads, their tags and links.
threads:write	Assign, snooze, close, tag and link threads.
messages:read	Read the messages and notes in threads.
messages:write	Send replies, add notes, send automated messages and log messages sent elsewhere.
tasks:read	See tasks and follow-ups, and who they are for.
tasks:write	Add, change, complete and delete tasks.
appointments:read	See booked appointments, such as test drives and viewings.
appointments:write	Book, move and cancel appointments, which can message the customer.
events:read	See the events recorded for contacts, and the event types in use.
events:write	Tell Threadkite what happened to a contact in your system (a purchase, a finance agreement ending), which can start automations and set contact fields.
records:read	See the records other systems keep up to date on contacts (invoices, e-sign requests, documents) and their history.
records:write	Delete records your system sent. Events that mention a record add and update it.
flows:read	See automations, their runs and how they are doing.
flows:write	Create, change, publish, pause and test automations, and add threads to them. Automations can message customers.
segments:read	See saved segments of contacts, how many are in each and who.
reports:read	Read lead, response time, outcome, team, tag, sales, funnel, location and automation reports, and download them as CSV.
reports:write	Enter spend per source and set monthly targets for people and locations.
sales:read	List sales and the leads they are credited to.
sales:write	Tell Threadkite a customer bought, so the sale counts in the reports and is credited to their leads.
imports:read	See history imports from other systems and what each one brought in.
imports:write	Bring in contacts, threads and their past messages from another system without sending anything or starting automations, and undo an import.
webhooks:manage	Add, change and remove webhook endpoints and replay deliveries.

A :write scope includes the matching :read scope. A key without the scope an endpoint needs gets 403 with code insufficient_scope.