Help Scout node reference - all 153 operations, the credential it needs, and a worked example.
Help Scout Inbox (Mailbox) API 2.0 (Support desk). 153 operations: conversations, threads, tags, custom fields and snooze; attachments; customers and their emails, phones, chat handles, social profiles, websites and address; customer and organization properties; organizations; inboxes, folders, custom fields, routing and saved replies; users, statuses and system users; teams, tags, workflows, webhooks, satisfaction ratings and the full reports surface.
Credential: Help Scout app token - see Credentials.
Each operation below lists the requirement it needs. Requirements are not granted on the token at all - Help Scout has NO scopes. The Inbox API is OAuth2-only (there are no API keys and no personal access tokens), and a client_credentials exchange returns an access token, its type and expires_in and nothing else: no scope parameter, no consent screen, no scope section anywhere in the authentication reference. What a token IS, in Help Scout's own words, is a set of app credentials "associated with an active, invited user" - so the token simply acts as that person, and every refusal is about them, their ROLE, or the account's PLAN. The column below states which. Four things catch people out. First, and by far the most expensive: an access token lives exactly 172,800 seconds - two days - and the client-credentials grant returns NO refresh token, so a pasted token is a workflow with a 48-hour fuse; store the credential as clientId:clientSecret and Pipory mints a fresh one per run. Second, only FOUR endpoints in the entire 156-page reference state a role requirement of their own - create user, delete user, set ANOTHER user's status, and edit a thread's text - so the admin-ish rows below are honest about being Help Scout's UI permission matrix (Manage > Company > Permissions, where the Account Owner can hand Manage workflows, Manage saved replies, Manage custom fields, Delete conversations and even Access API itself to the plain User role) rather than something the API documents. Third, a Light User cannot use the API at all - "Access the API or apps" is in Help Scout's explicit cannot-do list for that role - and cannot be a conversation assignee either, so a token minted under one fails everything, not just the gated calls. Fourth, no role change fixes a PLAN gate: the API is unavailable on Free entirely, all 32 reporting endpoints are Plus/Pro-only, Teams and custom fields are Plus/Pro, and the rate limit itself is the plan (200 requests/minute on Standard, 400 on Plus, 800 on Pro, with every write counting as TWO). And the reason this table exists at all: Help Scout's 403 body does not say which of these tripped - its own error reference calls "Access denied" a catch-all for "the API is disabled for your company, payment information is missing or you don't have access to features like Reports". If a run fails with a permission error, the node names the missing requirement in the error - grant it and re-run; you do not need to rebuild the workflow.
| Operation | What it does | Requirement |
|---|
createConversation | Create conversation | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listConversations | List / search conversations | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getConversation | Get conversation | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getConversationV3 | Get conversation (v3 — real system_user type) | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
deleteConversation | Delete conversation | (no scope — but Help Scout's company permission matrix has a "Delete conversations" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
updateConversationSubject | Change subject | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateConversationStatus | Change status | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
assignConversation | Assign to a user | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
unassignConversation | Unassign | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
moveConversation | Move to another inbox | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
changePrimaryCustomer | Change primary customer | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
publishDraftConversation | Publish draft conversation | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
| Operation | What it does | Requirement |
|---|
updateConversationTags | Set tags (replaces all) | (no scope — but Help Scout's company permission matrix has a "Add or remove conversation tags" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
updateConversationFields | Set custom fields (replaces all) | (no scope — but Help Scout's company permission matrix has a "Manage custom fields — itself a Plus/Pro-only feature" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
snoozeConversation | Snooze conversation | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
unsnoozeConversation | Unsnooze conversation | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
| Operation | What it does | Requirement |
|---|
createReply | Reply to customer | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
createNote | Add internal note | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
createCustomerThread | Add customer message | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
createChatThread | Add chat thread | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
createPhoneThread | Add phone thread | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listThreads | List threads | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
listThreadsV3 | List threads (v3 — real system_user type) | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
updateThreadText | Edit thread text | (no scope — but the user behind the token must be an Administrator, OR the account's "Edit threads" permission must be granted to the User role. This is the one non-user endpoint whose API page states its own gate) |
setThreadHidden | Hide / unhide thread | (no scope — but the user behind the token must be an Administrator, OR the account's "Edit threads" permission must be granted to the User role. This is the one non-user endpoint whose API page states its own gate) |
getThreadSource | Get original source (JSON) | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getThreadSourceRfc822 | Get original source (raw .eml) | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
scheduleThread | Schedule thread to send later | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
publishThreadSchedule | Send a scheduled thread now | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteThreadSchedule | Cancel a scheduled thread | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
| Operation | What it does | Requirement |
|---|
uploadAttachment | Upload attachment to a thread | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
getAttachmentData | Get attachment data (base64) | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
downloadAttachmentFile | Download attachment file | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteAttachment | Delete attachment (draft only) | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
| Operation | What it does | Requirement |
|---|
createCustomer | Create customer | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listCustomers | List / search customers | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
listCustomersV3 | List customers (v3 — cursor paging) | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getCustomer | Get customer | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
updateCustomer | Update customer (partial) | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
overwriteCustomer | Overwrite customer (destructive) | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomer | Delete customer | (no scope — but Help Scout answers 403 if the user behind the token cannot access ALL of the customer's conversations, or if the customer has more than 100 of them. This is a hard delete of the customer AND their conversations, with no undo) |
deleteCustomerAsync | Delete customer (async) | (no scope — but Help Scout answers 403 if the user behind the token cannot access ALL of the customer's conversations, or if the customer has more than 100 of them. This is a hard delete of the customer AND their conversations, with no undo) |
| Operation | What it does | Requirement |
|---|
listCustomerEmails | List emails | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createCustomerEmail | Add email | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateCustomerEmail | Update email | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomerEmail | Delete email | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listCustomerPhones | List phones | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createCustomerPhone | Add phone | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateCustomerPhone | Update phone | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomerPhone | Delete phone | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listCustomerChatHandles | List chat handles | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createCustomerChatHandle | Add chat handle | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateCustomerChatHandle | Update chat handle | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomerChatHandle | Delete chat handle | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listCustomerSocialProfiles | List social profiles | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createCustomerSocialProfile | Add social profile | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateCustomerSocialProfile | Update social profile | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomerSocialProfile | Delete social profile | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listCustomerWebsites | List websites | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createCustomerWebsite | Add website | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateCustomerWebsite | Update website | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomerWebsite | Delete website | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
getCustomerAddress | Get address | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createCustomerAddress | Create address | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateCustomerAddress | Update address | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteCustomerAddress | Delete address | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
| Operation | What it does | Requirement |
|---|
listCustomerProperties | List property definitions | (no scope — but customer properties are a plan feature: non-legacy Plus and Company plans only) |
createCustomerProperty | Create property definition | (no scope — the API page states no requirement, but Help Scout's properties documentation does: Account Owners and Administrators can create and edit properties; all users can view them. Properties are available on all PAID plans) |
deleteCustomerProperty | Delete property definition | (no scope — the API page states no requirement, but Help Scout's properties documentation does: Account Owners and Administrators can create and edit properties; all users can view them. Properties are available on all PAID plans) |
updateCustomerPropertyValues | Set property values on a customer | (no scope — but customer properties are a plan feature: non-legacy Plus and Company plans only) |
| Operation | What it does | Requirement |
|---|
listOrganizations | List organizations | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getOrganization | Get organization | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createOrganization | Create organization | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
updateOrganization | Update organization (full replace) | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
deleteOrganization | Delete organization | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listOrganizationConversations | List an organization's conversations | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
listOrganizationCustomers | List an organization's customers | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
| Operation | What it does | Requirement |
|---|
listOrganizationProperties | List property definitions | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getOrganizationProperty | Get property definition | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createOrganizationProperty | Create property definition | (no scope — the API page states no requirement, but Help Scout's properties documentation does: Account Owners and Administrators can create and edit properties; all users can view them. Properties are available on all PAID plans) |
updateOrganizationProperty | Update property definition | (no scope — the API page states no requirement, but Help Scout's properties documentation does: Account Owners and Administrators can create and edit properties; all users can view them. Properties are available on all PAID plans) |
deleteOrganizationProperty | Delete property definition | (no scope — the API page states no requirement, but Help Scout's properties documentation does: Account Owners and Administrators can create and edit properties; all users can view them. Properties are available on all PAID plans) |
setOrganizationPropertyValue | Set a property value | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
removeOrganizationPropertyValue | Remove a property value | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
| Operation | What it does | Requirement |
|---|
listMailboxes | List inboxes | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getMailbox | Get inbox | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
listMailboxFolders | List inbox folders | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
listMailboxFields | List inbox custom fields | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getMailboxRouting | Get routing configuration | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
updateMailboxRouting | Update routing configuration | (no scope — but Help Scout's company permission matrix has a "Manage routing — itself a Plus/Pro-only feature" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
| Operation | What it does | Requirement |
|---|
listSavedReplies | List saved replies | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getSavedReply | Get saved reply | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createSavedReply | Create saved reply | (no scope — but Help Scout's company permission matrix has a "Manage saved replies" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
updateSavedReply | Update saved reply | (no scope — but Help Scout's company permission matrix has a "Manage saved replies" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
deleteSavedReply | Delete saved reply | (no scope — but Help Scout's company permission matrix has a "Manage saved replies" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
| Operation | What it does | Requirement |
|---|
getMe | Get the token's own user | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
listUsers | List users | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getUser | Get user | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createUser | Create user | (no scope — but Help Scout's API reference states this one plainly: only Administrators and Account Owners may call it) |
deleteUser | Delete user | (no scope — but Help Scout's API reference states this one plainly: only Administrators and Account Owners may call it) |
listUserStatuses | List user statuses | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getUserStatus | Get a user's status | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
setUserStatus | Set a user's status | (no scope — a user may always set their OWN status; Help Scout's reference states that setting ANOTHER user's status needs an Administrator or the Account Owner) |
getConversationReassignment | Get conversation reassignment config | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
updateConversationReassignment | Update conversation reassignment | (no scope — the token acts as the Help Scout user it was issued for, so this needs that user to have access to the inbox the conversation or customer belongs to) |
listSystemUsers | List system (AI) users | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getSystemUser | Get system (AI) user | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
| Operation | What it does | Requirement |
|---|
listTeams | List teams | (no scope — but Help Scout's company permission matrix has a "Teams — a Plus/Pro-only feature, so a Standard account has none to list" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
listTeamMembers | List team members | (no scope — but Help Scout's company permission matrix has a "Teams — a Plus/Pro-only feature, so a Standard account has none to list" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
updateTeamMembers | Add / remove team members | (no scope — but Help Scout's company permission matrix has a "Teams: create, edit, delete — itself a Plus/Pro-only feature" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
listTags | List tags | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getTag | Get tag | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
| Operation | What it does | Requirement |
|---|
listWorkflows | List workflows | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
updateWorkflowStatus | Activate / deactivate workflow | (no scope — but Help Scout's company permission matrix has a "Manage workflows" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
runWorkflow | Run a manual workflow on conversations | (no scope — but Help Scout's company permission matrix has a "Manage workflows" toggle, off for the User role by default. Its API page states no requirement at all, so this is the UI gate, not a documented one: an Administrator's credentials always work, and the Account Owner can grant it to a plain User under Manage > Company > Permissions) |
| Operation | What it does | Requirement |
|---|
listWebhooks | List webhooks | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
getWebhook | Get webhook | (no scope — the token acts as the Help Scout user it was issued for, and returns only what that user can already see in Help Scout) |
createWebhook | Create webhook | (no scope, and no documented requirement — Help Scout's webhook pages state none. Webhooks are configured under Manage > Apps in the UI, which is administrator territory, so use an Administrator's credentials if a 403 comes back) |
updateWebhook | Update webhook | (no scope, and no documented requirement — Help Scout's webhook pages state none. Webhooks are configured under Manage > Apps in the UI, which is administrator territory, so use an Administrator's credentials if a 403 comes back) |
deleteWebhook | Delete webhook | (no scope, and no documented requirement — Help Scout's webhook pages state none. Webhooks are configured under Manage > Apps in the UI, which is administrator territory, so use an Administrator's credentials if a 403 comes back) |
| Operation | What it does | Requirement |
|---|
getRating | Get satisfaction rating | (no scope and no plan gate — but note this reads ONE rating by id. Listing ratings is only possible through the Happiness ratings report, which is Plus/Pro only) |
| Operation | What it does | Requirement |
|---|
reportCompany | Company overall | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportCompanyCustomersHelped | Company customers helped | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportCompanyDrilldown | Company drilldown | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversations | Conversations overall | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsVolumeByChannel | Volume by channel | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsBusyTimes | Busiest time of day | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsDrilldown | Conversations drilldown | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsFieldsDrilldown | Drilldown by field | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsNew | New conversations | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsNewDrilldown | New conversations drilldown | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportConversationsReceivedMessages | Received messages | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
| Operation | What it does | Requirement |
|---|
reportProductivity | Productivity overall | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportProductivityFirstResponseTime | First response time | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportProductivityResponseTime | Response time | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportProductivityResolutionTime | Resolution time | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportProductivityRepliesSent | Replies sent | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportProductivityResolved | Resolved | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportHappiness | Happiness overall | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportHappinessRatings | Happiness ratings (the ratings list) | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportDocs | Docs overall | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportChat | Chat channel report | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportEmail | Email channel report | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportPhone | Phone channel report | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
| Operation | What it does | Requirement |
|---|
reportUser | User / team overall | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserChat | User chat | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserConversationHistory | User conversation history | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserCustomersHelped | User customers helped | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserDrilldown | User drilldown | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserHappiness | User happiness | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserRatings | User happiness drilldown (ratings) | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserReplies | User replies | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |
reportUserResolutions | User resolutions | (no scope — but a PLAN gate: every reporting endpoint's page carries the line "only available to Plus and Pro plans", so a Standard-plan token gets a 403 no matter who owns it) |