> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useorbitcrm.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# App Permissions

> OAuth scopes define what your app can access on behalf of users. Request only the permissions your app needs—users are more likely to approve apps that request minimal access.

> [!NOTE]
>
> **Principle of Least Privilege** — Only request scopes that are essential for your app's core functionality. You can always request additional permissions later if needed.

> [!NOTE]
>
> AI assistants that register themselves (Claude, ChatGPT and other MCP clients) can be granted every scope below except the `:delete` scopes. Write scopes still remove what they manage: for example `dialer:write` can permanently delete call recordings and transcripts, and `crm:write` can remove pipelines, stages, fields and saved views.

## Forms

| Scope | Description |
| - | - |
| `forms:read` | View your forms, their fields and settings |
| `forms:write` | Create and update forms |
| `forms:delete` | Delete forms |

## Submissions

| Scope | Description |
| - | - |
| `submissions:read` | View form submissions and the answers people gave |
| `submissions:write` | Change the answers stored on form submissions |
| `submissions:delete` | Delete form submissions and the files uploaded with them |

## Contacts & tags

| Scope | Description |
| - | - |
| `contacts:read` | View your contacts, their tags and your contact imports |
| `contacts:write` | Create, update, import and merge contacts and manage tags. An import can overwrite existing contacts' details and add the companies and tags it names; a merge archives the duplicate contact |
| `contacts:delete` | Delete contacts |

## CRM setup

| Scope | Description |
| - | - |
| `crm:read` | View pipelines, stages, custom fields, CRM settings, saved views, your workspace members and teams (member groups), and who can see each pipeline |
| `crm:write` | Create, change and remove pipelines, stages, custom fields, saved views and teams (member groups); change CRM settings and who can see each pipeline |

## Companies

| Scope | Description |
| - | - |
| `companies:read` | View your companies |
| `companies:write` | Create, update and merge companies; a merge moves the duplicate company to Recently deleted |
| `companies:delete` | Delete companies |

## Deals

| Scope | Description |
| - | - |
| `deals:read` | View deals, their contacts and stage history, and pipeline totals |
| `deals:write` | Create, update and merge deals, move them between stages, and add or remove the contacts on a deal; a merge moves the duplicate deal to Recently deleted |
| `deals:delete` | Delete deals |

## Tasks

| Scope | Description |
| - | - |
| `tasks:read` | View tasks |
| `tasks:write` | Create, update, complete and delete tasks |

## Notes

| Scope | Description |
| - | - |
| `notes:read` | View notes on contacts, companies and deals, and comments on notes and logged activity |
| `notes:write` | Create, edit and delete notes, and comment on notes and logged activity |

## Activity

| Scope | Description |
| - | - |
| `activities:read` | View each record's timeline and the logged and synced emails on it (including email synced from members' connected Gmail or Outlook mailboxes), calls, meetings, messages and notes, including email bodies, and activity imports |
| `activities:write` | Log, edit and delete emails, calls, meetings and messages on contacts, companies and deals, and import activity history in bulk; an admin can undo an import, which deletes everything it created. Nothing is sent: these record what already happened |

## Files

| Scope | Description |
| - | - |
| `files:read` | View the files on contacts, companies and deals and download them |
| `files:write` | Attach files to contacts, companies and deals, fetch files from URLs you provide into the workspace, and delete files |

## Workflows

| Scope | Description |
| - | - |
| `workflows:read` | View workflows, their runs and AI agent templates |
| `workflows:write` | Create, update, activate, pause and run workflows, and manage AI agent templates. Active and running workflows carry out their steps, which can email people, enroll contacts in sequences, change CRM records and send data to connected apps and webhooks |
| `workflows:delete` | Delete workflows and AI agent templates |

## Dialer

| Scope | Description |
| - | - |
| `dialer:read` | View dialer settings, the workspace's phone numbers and who each is assigned to, calling costs, call lists, dialing sessions, calls with their outcomes and notes, call statistics, call transcripts and AI coaching feedback, call scripts, voicemail greeting details and the do-not-call list |
| `dialer:write` | Change dialer settings (including turning call recording, paid transcription and AI feedback on or off), assign the workspace's phone numbers to members, set call outcomes and notes, write and delete call scripts, permanently delete call recordings and transcripts, and add or remove do-not-call numbers. Never places calls, buys numbers or changes billing |

## Meetings

| Scope | Description |
| - | - |
| `meetings:read` | View meetings and who they are with |
| `meetings:write` | Book meetings on your team's calendars, which sends calendar invites to the attendee, and change a meeting's status (including cancelling it, which tells the attendee) and notes |
| `meetings:delete` | Delete meetings |

## Scheduling

| Scope | Description |
| - | - |
| `scheduling:read` | View scheduling pages, event types, availability schedules and open booking slots |
| `scheduling:write` | Create and update scheduling pages and event types |
| `scheduling:delete` | Delete scheduling pages and event types |

## Sequences

| Scope | Description |
| - | - |
| `sequences:read` | View email sequences, their steps, enrollments, analytics and unsubscribes, and email templates and snippets |
| `sequences:write` | Enroll contacts in email sequences, which then emails them, add addresses to the unsubscribe list, and create, edit and delete email templates and snippets |
| `sequences:manage` | Create email sequences, write and change their steps, settings and sender, and activate or pause them. An active sequence emails everyone enrolled in it |
| `sequences:delete` | Remove contacts from email sequences |

## Emails

| Scope | Description |
| - | - |
| `emails:read` | View the one-to-one emails your team sends contacts from Orbit: sender, recipient, subject, message and whether each was delivered, opened, replied to or bounced |
| `emails:send` | Send emails to your contacts from your Orbit sending address. Each email reaches someone outside the workspace and can't be unsent |

## Webhooks

| Scope | Description |
| - | - |
| `webhooks:read` | View webhook subscriptions and the URLs they deliver to |
| `webhooks:write` | Create, change and delete webhooks that send events about forms, contacts, companies, deals, tasks, meetings and calls to any URL. Subscribing to an object also needs its read scope |

## Integrations

| Scope | Description |
| - | - |
| `integrations:read` | See which apps are connected to your workspace and whether they are syncing. Never their passwords, keys or tokens |

## Team

| Scope | Description |
| - | - |
| `team:read` | View your workspace's name and URL slug |

## Analytics

| Scope | Description |
| - | - |
| `analytics:read` | View form analytics: views, submissions and conversion rates, by day and by traffic source, device and country |

## Profile

| Scope | Description |
| - | - |
| `user:read` | View your name and email address |

## Retired scopes

`team:write`, `team:members` and `user:write` were retired in October 2026. They never gave access to anything, and Orbit no longer grants them: authorization requests and new API keys drop them, and new apps can't request them.

## Requesting Scopes

Include the scopes you need in the authorization URL as a space-separated list:

```
scope=forms:read submissions:read webhooks:read webhooks:write
```

## Common Scope Combinations

### Read-only Dashboard

View forms and submissions without making changes

`forms:read` `submissions:read`

### Form Builder

Create and manage form configurations

`forms:read` `forms:write`

### Full Integration

Complete access for building comprehensive integrations

`forms:read` `forms:write` `submissions:read` `webhooks:read` `webhooks:write`

## Next Steps

> [card] [OAuth Setup](https://docs.useorbitcrm.ai/apps/oauth.md)
>
> Implement the authorization flow

> [card] [App Review](https://docs.useorbitcrm.ai/apps/app-review.md)
>
> Submit for marketplace listing


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.