# API endpoint permissions > Choose Read and Write grants and look up the permission ID for every supported API operation. Audience: Administrators and integration developers Kind: Reference Canonical: https://shuffl.ai/docs/api-permissions ## Choose exact grants In Settings, search for a resource or operation, select Read or Write for a group, or expand it to pick individual endpoints. A minus means a partial selection. teams.current and permissions.list work with any authorized key. Every other operation needs an exact grant plus current tenant, membership, role, employee-access and resource checks. The catalog may list operations your role or deployment doesn’t offer. To see what you can grant and hold, use permissions.list in the SDK, GET /api/v1/permissions or shuffl permissions list --json. ### Grants don’t imply each other - users.list doesn’t grant users.get. - groups.save doesn’t grant groups.list or groups.remove. - Write never includes Read. - [Open API keys](https://shuffl.ai/app/settings/api-keys) - [OpenAPI input/output schemas and HTTP paths](https://shuffl.ai/api/v1/openapi.json) ## Revocation, replacement and delegation Grants are fixed when a key is issued. To change them, create a replacement and revoke the old key. Revocation and expiry also invalidate keys issued from it. New endpoints never join an existing key. MCP access is the mcp.knowledge permission, checked by the MCP server rather than an HTTP endpoint. API permissions don’t grant browser sign-in, provider OAuth consent or access to another workspace. ### Delegating keys - Creating a credential through the SDK, API or CLI takes permissions: ["users.list"]. - The issuer must hold credentials.api.create and every permission it grants. The grants must fit within the parent and all its ancestors. - Delegation goes at most three generations deep and can’t outlive its parent. - A key with credentials.api.create can delegate mcp.knowledge only if it holds mcp.knowledge itself. ## Company keys The company API is in OpenAPI, the SDK (shuffl.company) and the CLI (shuffl login --company or SHUFFL_COMPANY_KEY). The Company settings API reference has examples for each. Deleting or restoring the company, transferring ownership, company roles, email domains, single sign-on, SCIM, Slack mapping, billing and product analytics stay in Settings for every credential. ### Two kinds of key - A workspace key (shuffl_api_) works in one workspace with the permissions above. - A company key (shuffl_company_) manages one company’s settings. It can’t read or change anything inside a workspace: no People, Knowledge, requests or programs. - Neither works where the other does. The wrong kind gets 401. ### Company keys - Company owners and administrators create them in Settings → API keys and webhooks → Company keys. - A key acts as its creator, with their current company role. It pauses while they aren’t a company owner or administrator. - Keys last 7, 30 or 90 days with 120 requests a minute. A company can have 10 active. - Creating or revoking a key, and every change made with one, is recorded for Shuffl support. ### Over HTTP - GET /api/v1/company shows the key’s company and grants. - GET /api/v1/company/ runs a read. POST with a JSON body runs a change. - The company always comes from the key. ### Company keys can be granted - company.details: read the company name, logo and default workspace - company.workspaces.list: list the company's workspaces - company.members.list: list company members and their company roles - company.emailDomains.list: list the company's email domains and their verification - company.slack.list: list the slack workspaces connected to the company - company.rename: rename the company - company.workspaces.setDefault: choose the workspace new email domain and single sign-on members join - company.members.remove: remove someone from the company (administrators only with an owner’s key) SDK: ```ts import { Shuffl } from '@shuffl/sdk'; const shuffl = new Shuffl({ apiKey: process.env.SHUFFL_COMPANY_KEY! }); const { items } = await shuffl.company.members.list({ limit: 100 }); await shuffl.company.members.remove({ userId: '' }); ``` CLI: ```sh shuffl company members list --limit 100 --json shuffl company members remove --user-id "" --json ``` HTTP: ```sh curl "https://shuffl.ai/api/v1/company/members.list?limit=100" \ -H "Authorization: Bearer $SHUFFL_COMPANY_KEY" curl -X POST https://shuffl.ai/api/v1/company/members.remove \ -H "Authorization: Bearer $SHUFFL_COMPANY_KEY" \ -H "Content-Type: application/json" \ -d '{"userId":""}' ``` - [Open Company API keys](https://shuffl.ai/app/settings/company/api-keys) - [Company settings API reference](https://shuffl.ai/docs/api-reference/company) ## access ### access.get Read · Read one person's workspace role and app access Exact permission: `access.get`. Underlying role scope: `access:read`. ### access.slackWaiting Read · List Slack members waiting for access to Shuffl Exact permission: `access.slackWaiting`. Underlying role scope: `access:read`. ### access.enableSlack Write · Give these Slack people employee access Exact permission: `access.enableSlack`. Underlying role scope: `access:write`. ### access.save Write · Change employee product access Exact permission: `access.save`. Underlying role scope: `access:write`. ### access.saveRole Write · Change a member’s team role Exact permission: `access.saveRole`. Underlying role scope: `access:write`. ## actions ### actions.mine Read · List the requests Mello filed for you and where each stands Exact permission: `actions.mine`. Underlying role scope: `self:read`. ## assistant ### assistant.conversations Read · List your conversations with Mello Exact permission: `assistant.conversations`. Underlying role scope: `assistant:read`. ### assistant.history Read · Read the messages in one of your conversations with Mello Exact permission: `assistant.history`. Underlying role scope: `assistant:read`. ### assistant.delete Write · Delete one of your conversations with Mello Exact permission: `assistant.delete`. Underlying role scope: `assistant:write`. ### assistant.send Write · Ask Mello a question in a conversation Exact permission: `assistant.send`. Underlying role scope: `assistant:write`. ### assistant.stop Write · Stop an answer Mello is still writing Exact permission: `assistant.stop`. Underlying role scope: `assistant:write`. ## badges ### badges.holders Read · List the people who hold a badge, as far as each lets you see Exact permission: `badges.holders`. Underlying role scope: `users:read`. ### badges.list Read · List the team’s badges, who holds them and any open requests you decide Exact permission: `badges.list`. Underlying role scope: `users:read`. ### badges.ofPerson Read · List a person's badges Exact permission: `badges.ofPerson`. Underlying role scope: `users:read`. ### badges.settings Read · Read the badge suggestion settings Exact permission: `badges.settings`. Underlying role scope: `praise:read`. ### badges.award Write · Give a badge you own to a person Exact permission: `badges.award`. Underlying role scope: `profile:write`. ### badges.claim Write · Claim a badge with its code Exact permission: `badges.claim`. Underlying role scope: `profile:write`. ### badges.decideRequest Write · Approve or decline a request for a badge Exact permission: `badges.decideRequest`. Underlying role scope: `profile:write`. ### badges.generatePicture Write · Draw an AI picture for a badge you own. Keeps a picture already set unless replace is true; idea says what to draw Exact permission: `badges.generatePicture`. Underlying role scope: `profile:write`. ### badges.hideOwn Write · Hide or show one of your badges on your profile Exact permission: `badges.hideOwn`. Underlying role scope: `profile:write`. ### badges.request Write · Ask for a badge Exact permission: `badges.request`. Underlying role scope: `profile:write`. ### badges.revoke Write · Take a badge back from a person Exact permission: `badges.revoke`. Underlying role scope: `profile:write`. ### badges.save Write · Create or edit a badge you own Exact permission: `badges.save`. Underlying role scope: `profile:write`. ### badges.saveSettings Write · Turn badge offers from praise on or off, and choose the launch channel Exact permission: `badges.saveSettings`. Underlying role scope: `praise:write`. ### badges.setHidden Write · Hide or show a badge for the whole workspace Exact permission: `badges.setHidden`. Underlying role scope: `users:write`. ### badges.uploadPicture Write · Set a badge picture from a PNG, JPEG or WebP picture sent as base64, for a badge you own Exact permission: `badges.uploadPicture`. Underlying role scope: `profile:write`. ## capabilities ### capabilities.requests Read · How many people asked HR to connect a system, per capability Exact permission: `capabilities.requests`. Underlying role scope: `integrations:read`. ### capabilities.sheet Read · What Mello can answer and do for you here, and what connecting a system would add Exact permission: `capabilities.sheet`. Underlying role scope: `self:read`. ### capabilities.unlocks Read · What people can ask and do once an HR system or document tool is connected Exact permission: `capabilities.unlocks`. Underlying role scope: `self:read`. ### capabilities.dismissRequests Write · Clear the asks to connect a system for one capability Exact permission: `capabilities.dismissRequests`. Underlying role scope: `integrations:write`. ### capabilities.requestConnection Write · Ask HR to connect the system this needs Exact permission: `capabilities.requestConnection`. Underlying role scope: `self:write`. ## celebrations ### celebrations.card Read · Open a celebration card you can sign or were given Exact permission: `celebrations.card`. Underlying role scope: `self:read`. ### celebrations.cards Read · List celebration cards to sign and cards you were given Exact permission: `celebrations.cards`. Underlying role scope: `self:read`. ### celebrations.deliveries Read · List the celebration messages Shuffl sent Exact permission: `celebrations.deliveries`. Underlying role scope: `celebrations:read`. ### celebrations.mine Read · List the celebrations you received Exact permission: `celebrations.mine`. Underlying role scope: `self:read`. ### celebrations.preferences Read · Read your birthday and work anniversary sharing preferences Exact permission: `celebrations.preferences`. Underlying role scope: `self:read`. ### celebrations.preview Read · Preview a celebration message Exact permission: `celebrations.preview`. Underlying role scope: `celebrations:read`. ### celebrations.program Read · Read the Celebrations settings Exact permission: `celebrations.program`. Underlying role scope: `celebrations:read`. ### celebrations.review Read · Review upcoming birthdays and work anniversaries Exact permission: `celebrations.review`. Underlying role scope: `celebrations:read`. ### celebrations.startDates Read · Read which start date anniversaries count from and the start dates that look wrong Exact permission: `celebrations.startDates`. Underlying role scope: `celebrations:read`. ### celebrations.thisWeek Read · List who was celebrated in a channel in the last seven days Exact permission: `celebrations.thisWeek`. Underlying role scope: `self:read`. ### celebrations.refresh Write · Look for new birthdays and work anniversaries to celebrate now Exact permission: `celebrations.refresh`. Underlying role scope: `celebrations:write`. ### celebrations.removeCardNote Write · Remove your note from this celebration card Exact permission: `celebrations.removeCardNote`. Underlying role scope: `self:write`. ### celebrations.save Write · Save celebration settings; enabling them schedules messages Exact permission: `celebrations.save`. Underlying role scope: `celebrations:write`. ### celebrations.saveAnniversaryDate Write · Choose which start date work anniversaries count from; reschedules them Exact permission: `celebrations.saveAnniversaryDate`. Underlying role scope: `celebrations:write`. ### celebrations.savePreferences Write · Save your birthday and work anniversary sharing preferences Exact permission: `celebrations.savePreferences`. Underlying role scope: `self:write`. ### celebrations.signCard Write · Sign this celebration card with your note Exact permission: `celebrations.signCard`. Underlying role scope: `self:write`. ## channels ### channels.list Read · List available Slack channels Exact permission: `channels.list`. Underlying role scope: `programs:read`. ## commands ### commands.get Read · Read your own command receipt Exact permission: `commands.get`. Underlying role scope: `null`. ## communities ### communities.channelSuggestions Read · List Slack channels, with the ones that look like communities suggested Exact permission: `communities.channelSuggestions`. Underlying role scope: `programs:read`. ### communities.createCapabilities Read · Read the current permission to create public or private community channels Exact permission: `communities.createCapabilities`. Underlying role scope: `programs:read`. ### communities.list Read · List communities with the members you may see Exact permission: `communities.list`. Underlying role scope: `users:read`. ### communities.members Read · List a community's members Exact permission: `communities.members`. Underlying role scope: `users:read`. ### communities.ofPerson Read · List the communities a person belongs to Exact permission: `communities.ofPerson`. Underlying role scope: `users:read`. ### communities.archive Write · Archive a community Exact permission: `communities.archive`. Underlying role scope: `profile:write`. ### communities.createSlackChannel Write · Create an explicitly public or private Slack channel as an authorized community owner or administrator, retaining its request id across retries Exact permission: `communities.createSlackChannel`. Underlying role scope: `programs:write`. ### communities.fromChannels Write · Create one community per chosen Slack channel, as an administrator Exact permission: `communities.fromChannels`. Underlying role scope: `programs:write`. ### communities.generateCover Write · Draw an AI cover for a community, as its owner, moderator or an administrator. Keeps a cover already set unless replace is true; idea says what to draw Exact permission: `communities.generateCover`. Underlying role scope: `profile:write`. ### communities.invite Write · Invite selected people to a community as its owner or administrator; each person must accept Exact permission: `communities.invite`. Underlying role scope: `profile:write`. ### communities.join Write · Join a community Exact permission: `communities.join`. Underlying role scope: `profile:write`. ### communities.leave Write · Leave a community Exact permission: `communities.leave`. Underlying role scope: `profile:write`. ### communities.removeMember Write · Remove someone from a community, as its owner or moderator Exact permission: `communities.removeMember`. Underlying role scope: `profile:write`. ### communities.revokeInvitation Write · Revoke a pending community invitation as its owner or administrator Exact permission: `communities.revokeInvitation`. Underlying role scope: `profile:write`. ### communities.save Write · Create or edit a community, optionally tied to a Slack channel Exact permission: `communities.save`. Underlying role scope: `profile:write`. ### communities.setVisibility Write · Show or hide a community on your profile Exact permission: `communities.setVisibility`. Underlying role scope: `profile:write`. ### communities.sync Write · Sync a community's members with its Slack channel now Exact permission: `communities.sync`. Underlying role scope: `profile:write`. ### communities.uploadCover Write · Set a community cover from a PNG, JPEG or WebP picture sent as base64, as its owner, moderator or an administrator Exact permission: `communities.uploadCover`. Underlying role scope: `profile:write`. ## credentials.api ### credentials.api.list Read · List the workspace's API keys and what each can do Exact permission: `credentials.api.list`. Underlying role scope: `credentials:read`. ### credentials.api.create Write · Delegate a subset of this credential with bounded expiry and inherited revocation Exact permission: `credentials.api.create`. Underlying role scope: `credentials:write`. ### credentials.api.revoke Write · Revoke an API key Exact permission: `credentials.api.revoke`. Underlying role scope: `credentials:write`. ## digest ### digest.culture Read · List the Culture page’s recommendations in order and what happened after each one acted on Exact permission: `digest.culture`. Underlying role scope: `reports:read`. ### digest.nudge Read · Read one of Mello’s culture nudges Exact permission: `digest.nudge`. Underlying role scope: `reports:read`. ### digest.nudges Read · List Mello’s culture nudges for the workspace Exact permission: `digest.nudges`. Underlying role scope: `reports:read`. ### digest.preview Read · Preview the HR digest for the last period Exact permission: `digest.preview`. Underlying role scope: `reports:read`. ### digest.settings Read · Read the HR digest schedule Exact permission: `digest.settings`. Underlying role scope: `team:read`. ### digest.actOnNudge Write · Record that a culture nudge was acted on and get where its action goes Exact permission: `digest.actOnNudge`. Underlying role scope: `team:write`. ### digest.dismissNudge Write · Dismiss a culture nudge for 90 days Exact permission: `digest.dismissNudge`. Underlying role scope: `team:write`. ### digest.saveSettings Write · Save the HR digest schedule and admin channel Exact permission: `digest.saveSettings`. Underlying role scope: `team:write`. ## exports ### exports.team Read · Export the workspace's programs, people and introduction history Exact permission: `exports.team`. Underlying role scope: `exports:read`. ## getStarted ### getStarted.celebration Read · Read the first-action celebration waiting for you, if any Exact permission: `getStarted.celebration`. Underlying role scope: `self:read`. ### getStarted.get Read · Read your own Get started steps and whether the welcome still shows Exact permission: `getStarted.get`. Underlying role scope: `self:read`. ### getStarted.celebrate Write · Record that a celebration was shown, shared or dismissed Exact permission: `getStarted.celebrate`. Underlying role scope: `profile:write`. ### getStarted.dismiss Write · Hide the Get started card Exact permission: `getStarted.dismiss`. Underlying role scope: `profile:write`. ### getStarted.draftIntro Write · Draft a short hello to your coworkers with Mello; nothing is posted Exact permission: `getStarted.draftIntro`. Underlying role scope: `profile:write`. ### getStarted.intro Write · Post your hello on Home, or skip it Exact permission: `getStarted.intro`. Underlying role scope: `profile:write`. ### getStarted.wizard Write · Record that you opened, finished or skipped the welcome Exact permission: `getStarted.wizard`. Underlying role scope: `profile:write`. ## groups ### groups.allAutomations Read · Every join and leave automation in the workspace: group automations with their group and last runs, playbooks that start on each start date or each last day (`dayZero`) and Connections programs whose people are a group; or only those that start one playbook, program or community Exact permission: `groups.allAutomations`. Underlying role scope: `users:read`. ### groups.automationChoices Read · The Pulse questions, badges and Shuffl lists a group automation can ask, give or add people to Exact permission: `groups.automationChoices`. Underlying role scope: `users:read`. ### groups.automationInsights Read · Group automation runs over the last `days` (30, 90 or 180) against the period before: done, skipped and failed, people reached, by week and kind, the top reasons a run did nothing, runs still scheduled and automations on; `groupId` narrows it Exact permission: `groups.automationInsights`. Underlying role scope: `users:read`. ### groups.automationRuns Read · Every group automation run in the workspace, newest first, 50 at a time (`next` is the cursor for the page after), with `counts` by outcome; `outcome` and `groupId` narrow it Exact permission: `groups.automationRuns`. Underlying role scope: `users:read`. ### groups.automations Read · A group’s automations (what happens when someone joins or leaves) and their last runs Exact permission: `groups.automations`. Underlying role scope: `users:read`. ### groups.directory Read · List the groups shown on profiles, yours first, with a few faces each Exact permission: `groups.directory`. Underlying role scope: `users:read`. ### groups.directoryGroup Read · Read one group shown on profiles and everyone in it Exact permission: `groups.directoryGroup`. Underlying role scope: `users:read`. ### groups.export Read · A group’s members as a CSV file: name, email, title, department, manager and when they joined Exact permission: `groups.export`. Underlying role scope: `users:read`. ### groups.get Read · Read one group: its rules, members and recent entries and exits Exact permission: `groups.get`. Underlying role scope: `users:read`. ### groups.glance Read · One group at a glance: size, joins, departments, tenure and time zones Exact permission: `groups.glance`. Underlying role scope: `users:read`. ### groups.list Read · List the workspace’s groups with who is in each Exact permission: `groups.list`. Underlying role scope: `users:read`. ### groups.members Read · One page of a group’s members Exact permission: `groups.members`. Underlying role scope: `users:read`. ### groups.message Read · One message to a group: its words, who it would reach now and how it reads to one member Exact permission: `groups.message`. Underlying role scope: `users:read`. ### groups.messages Read · The drafts and sends of messages to a group, newest first Exact permission: `groups.messages`. Underlying role scope: `users:read`. ### groups.options Read · The departments, teams, communities, programs, titles, locations and time zones a rule may name Exact permission: `groups.options`. Underlying role scope: `users:read`. ### groups.preview Read · Count and sample who a set of rules would hold today Exact permission: `groups.preview`. Underlying role scope: `users:read`. ### groups.searchPeople Read · Find people by name to pick for a group Exact permission: `groups.searchPeople`. Underlying role scope: `users:read`. ### groups.suggestions Read · Starter groups not made yet, with how many people each would hold Exact permission: `groups.suggestions`. Underlying role scope: `users:read`. ### groups.discardMessage Write · Drop a drafted message to a group Exact permission: `groups.discardMessage`. Underlying role scope: `users:write`. ### groups.prepareMessage Write · Write a message to everyone in a group and see who it would reach; nothing is sent Exact permission: `groups.prepareMessage`. Underlying role scope: `users:write`. ### groups.refresh Write · Re-evaluate a dynamic group’s rules now Exact permission: `groups.refresh`. Underlying role scope: `users:write`. ### groups.remove Write · Remove a group Exact permission: `groups.remove`. Underlying role scope: `users:write`. ### groups.removeAutomation Write · Remove an automation from a group, with its runs Exact permission: `groups.removeAutomation`. Underlying role scope: `users:write`. ### groups.save Write · Create or change a group or a department: a list of people or rules that keep it up to date Exact permission: `groups.save`. Underlying role scope: `users:write`. ### groups.sendMessage Write · Send a drafted message to a group once per request key, on each person’s chosen channel Exact permission: `groups.sendMessage`. Underlying role scope: `users:write`. ### groups.setAutomation Write · Add or change an automation on a group: send a message, ask a Pulse question, start a playbook, invite to a community, add to Connections, give a badge, add to or remove from another group, add to or post in a Slack channel (`config.channelId`, read back from Slack), or tell HR, their manager or someone named, right away or days later; a new one starts paused Exact permission: `groups.setAutomation`. Underlying role scope: `users:write`. ### groups.setAutomationState Write · Pause or resume an automation on a group Exact permission: `groups.setAutomationState`. Underlying role scope: `users:write`. ### groups.setPlaybookAutoStart Write · Turn on, pause or remove a playbook’s automation that starts it on each new hire’s start date, or a leaving playbook’s on each last day, for everyone or one group Exact permission: `groups.setPlaybookAutoStart`. Underlying role scope: `users:write`. ## home ### home.feed Read · What happened to people you know, and who Mello thinks you should meet Exact permission: `home.feed`. Underlying role scope: `self:read`. ### home.places Read · The areas turned on for you, what is waiting for you, and your onboarding progress Exact permission: `home.places`. Underlying role scope: `self:read`. ### home.preferences Write · Choose how Home looks: cards or compact, stories, autoplay, For you Exact permission: `home.preferences`. Underlying role scope: `profile:write`. ### home.react Write · Add or remove your emoji reaction on a Home moment Exact permission: `home.react`. Underlying role scope: `profile:write`. ### home.story Write · Record Home stories you opened, sent a note from, or skipped Exact permission: `home.story`. Underlying role scope: `profile:write`. ## hr ### hr.categories Read · Read the HR request categories and response target Exact permission: `hr.categories`. Underlying role scope: `hr:read`. ### hr.get Read · Read one HR request and its messages Exact permission: `hr.get`. Underlying role scope: `hr:read`. ### hr.list Read · List the HR requests you asked or can answer Exact permission: `hr.list`. Underlying role scope: `hr:read`. ### hr.mine Read · List the HR requests you asked, with HR’s latest reply Exact permission: `hr.mine`. Underlying role scope: `hr:read`. ### hr.readiness Read · Check whether HR requests have a destination and someone to answer them Exact permission: `hr.readiness`. Underlying role scope: `hr:read`. ### hr.settings Read · Read the HR team name and who answers HR requests Exact permission: `hr.settings`. Underlying role scope: `hr:read`. ### hr.shareSources Read · List your recent Mello conversations that an HR request can include Exact permission: `hr.shareSources`. Underlying role scope: `hr:read`. ### hr.command Write · Claim, release, reply to, note, categorize, resolve or reopen an HR request Exact permission: `hr.command`. Underlying role scope: `hr:write`. ### hr.configure Write · Change the HR request destination Exact permission: `hr.configure`. Underlying role scope: `hr:write`. ### hr.deliver Write · Deliver your HR reply to the employee Exact permission: `hr.deliver`. Underlying role scope: `hr:write`. ### hr.rebuildCategories Write · Have Mello rebuild the HR request categories from published Knowledge Exact permission: `hr.rebuildCategories`. Underlying role scope: `hr:write`. ### hr.renameTeam Write · Rename the HR team employees send requests to Exact permission: `hr.renameTeam`. Underlying role scope: `hr:write`. ### hr.retryDelivery Write · Retry HR request delivery Exact permission: `hr.retryDelivery`. Underlying role scope: `hr:write`. ### hr.saveCategories Write · Save the HR request categories, their owners and the response target Exact permission: `hr.saveCategories`. Underlying role scope: `hr:write`. ### hr.share Write · Share this request with the selected HR responders Exact permission: `hr.share`. Underlying role scope: `hr:write`. ## identities ### identities.list Read · List the Slack and web accounts linked to a person Exact permission: `identities.list`. Underlying role scope: `identities:read`. ### identities.slackAccounts Read · List Slack accounts that can be linked to people Exact permission: `identities.slackAccounts`. Underlying role scope: `identities:read`. ### identities.webAccounts Read · List web accounts that can be linked to people Exact permission: `identities.webAccounts`. Underlying role scope: `identities:read`. ### identities.linkSlack Write · Link a verified Slack account Exact permission: `identities.linkSlack`. Underlying role scope: `identities:write`. ### identities.linkWeb Write · Link a verified web account Exact permission: `identities.linkWeb`. Underlying role scope: `identities:write`. ### identities.unlink Write · Revoke an employee identity link Exact permission: `identities.unlink`. Underlying role scope: `identities:write`. ## integrations ### integrations.authorize Read · Get the link that connects Slack, Google Drive or Notion to the workspace Exact permission: `integrations.authorize`. Underlying role scope: `integrations:write`. ## invitations ### invitations.candidates Read · List people in the directory who can be invited to the workspace Exact permission: `invitations.candidates`. Underlying role scope: `access:read`. ### invitations.list Read · List pending workspace invitations Exact permission: `invitations.list`. Underlying role scope: `access:read`. ### invitations.cancel Write · Cancel a pending workspace invitation Exact permission: `invitations.cancel`. Underlying role scope: `access:write`. ### invitations.create Write · Invite this person with the selected team role Exact permission: `invitations.create`. Underlying role scope: `access:write`. ### invitations.createMany Write · Invite these people with the selected team role Exact permission: `invitations.createMany`. Underlying role scope: `access:write`. ### invitations.inviteDirectory Write · Invite everyone in the directory who is not invited yet Exact permission: `invitations.inviteDirectory`. Underlying role scope: `access:write`. ## knowledge ### knowledge.context Read · Read nearby approved passages Exact permission: `knowledge.context`. Underlying role scope: `knowledge:read`. ### knowledge.search Read · Search approved knowledge Exact permission: `knowledge.search`. Underlying role scope: `knowledge:read`. ## knowledge.acknowledgements ### knowledge.acknowledgements.mine Read · List the Knowledge pages you are asked to read and confirm Exact permission: `knowledge.acknowledgements.mine`. Underlying role scope: `knowledge:read`. ### knowledge.acknowledgements.status Read · See who has confirmed a Knowledge page and who has not Exact permission: `knowledge.acknowledgements.status`. Underlying role scope: `knowledge:manage`. ### knowledge.acknowledgements.close Write · Stop asking people to confirm this page Exact permission: `knowledge.acknowledgements.close`. Underlying role scope: `knowledge:write`. ### knowledge.acknowledgements.remind Write · Message the people who have not confirmed this page yet Exact permission: `knowledge.acknowledgements.remind`. Underlying role scope: `knowledge:write`. ### knowledge.acknowledgements.request Write · Ask the people who can read this page to confirm they read it, and message them Exact permission: `knowledge.acknowledgements.request`. Underlying role scope: `knowledge:write`. ## knowledge.connections ### knowledge.connections.browse Read · List documents a connected Knowledge source can see Exact permission: `knowledge.connections.browse`. Underlying role scope: `integrations:read`. ### knowledge.connections.list Read · List connected Knowledge providers Exact permission: `knowledge.connections.list`. Underlying role scope: `integrations:read`. ### knowledge.connections.requests Read · List requests to connect a Knowledge source Exact permission: `knowledge.connections.requests`. Underlying role scope: `integrations:read`. ### knowledge.connections.connect Write · Connect a Knowledge provider with a token Exact permission: `knowledge.connections.connect`. Underlying role scope: `integrations:write`. ### knowledge.connections.disconnect Write · Disconnect a knowledge provider Exact permission: `knowledge.connections.disconnect`. Underlying role scope: `integrations:write`. ### knowledge.connections.request Write · Ask an administrator to connect a Knowledge source Exact permission: `knowledge.connections.request`. Underlying role scope: `integrations:write`. ## knowledge.handbook ### knowledge.handbook.export Read · Download the pages published to everyone as one handbook, in Markdown Exact permission: `knowledge.handbook.export`. Underlying role scope: `knowledge:manage`. ## knowledge.policies ### knowledge.policies.coverage Read · Check which common HR policies Knowledge covers Exact permission: `knowledge.policies.coverage`. Underlying role scope: `knowledge:manage`. ## knowledge.sources ### knowledge.sources.get Read · Read a Knowledge source Exact permission: `knowledge.sources.get`. Underlying role scope: `knowledge:manage`. ### knowledge.sources.history Read · List a Knowledge source's versions Exact permission: `knowledge.sources.history`. Underlying role scope: `knowledge:manage`. ### knowledge.sources.list Read · List Knowledge sources Exact permission: `knowledge.sources.list`. Underlying role scope: `knowledge:manage`. ### knowledge.sources.search Read · Search Knowledge sources by title Exact permission: `knowledge.sources.search`. Underlying role scope: `knowledge:read`. ### knowledge.sources.archive Write · Archive an unpublished knowledge source Exact permission: `knowledge.sources.archive`. Underlying role scope: `knowledge:write`. ### knowledge.sources.changeAudience Write · Change who can read this knowledge source Exact permission: `knowledge.sources.changeAudience`. Underlying role scope: `knowledge:write`. ### knowledge.sources.importConnected Write · Import a document from a connected Knowledge source Exact permission: `knowledge.sources.importConnected`. Underlying role scope: `knowledge:write`. ### knowledge.sources.importWebsite Write · Import a website page into Knowledge for review Exact permission: `knowledge.sources.importWebsite`. Underlying role scope: `knowledge:write`. ### knowledge.sources.publish Write · Publish this knowledge version to its audience Exact permission: `knowledge.sources.publish`. Underlying role scope: `knowledge:write`. ### knowledge.sources.refresh Write · Refresh a Knowledge source from its connected provider Exact permission: `knowledge.sources.refresh`. Underlying role scope: `knowledge:write`. ### knowledge.sources.restore Write · Restore an archived knowledge source Exact permission: `knowledge.sources.restore`. Underlying role scope: `knowledge:write`. ### knowledge.sources.save Write · Save a Knowledge source draft Exact permission: `knowledge.sources.save`. Underlying role scope: `knowledge:write`. ### knowledge.sources.withdraw Write · Withdraw a published Knowledge source Exact permission: `knowledge.sources.withdraw`. Underlying role scope: `knowledge:write`. ### knowledge.sources.write Write · Write a Knowledge page with Mello from its title and a request; nothing is saved Exact permission: `knowledge.sources.write`. Underlying role scope: `knowledge:write`. ## knowledge.templates ### knowledge.templates.facts Read · Read what Shuffl knows that policy templates ask for Exact permission: `knowledge.templates.facts`. Underlying role scope: `knowledge:manage`. ### knowledge.templates.draft Write · Draft a policy template with Mello, researching each value; nothing is saved Exact permission: `knowledge.templates.draft`. Underlying role scope: `knowledge:write`. ## knowledge.uploads ### knowledge.uploads.get Read · Read the progress of a Knowledge file upload Exact permission: `knowledge.uploads.get`. Underlying role scope: `knowledge:write`. ### knowledge.uploads.appendPart Write · Upload the next part of a Knowledge file Exact permission: `knowledge.uploads.appendPart`. Underlying role scope: `knowledge:write`. ### knowledge.uploads.complete Write · Finish a Knowledge file upload and start reading it Exact permission: `knowledge.uploads.complete`. Underlying role scope: `knowledge:write`. ### knowledge.uploads.create Write · Start uploading a file to Knowledge Exact permission: `knowledge.uploads.create`. Underlying role scope: `knowledge:write`. ### knowledge.uploads.retry Write · Retry reading a Knowledge file that failed Exact permission: `knowledge.uploads.retry`. Underlying role scope: `knowledge:write`. ## manager ### manager.current Read · Read your own manager context Exact permission: `manager.current`. Underlying role scope: `manager:read`. ## mcp ### mcp.knowledge Read · Connect an agent over MCP Exact permission: `mcp.knowledge`. Underlying role scope: `knowledge:read`. ## mentorship ### mentorship.mine Read · Your mentorship programs and pairings, with goals and check-ins Exact permission: `mentorship.mine`. Underlying role scope: `self:read`. ### mentorship.join Write · Join a mentorship program as a mentor or mentee, saying what you can help with or want to learn Exact permission: `mentorship.join`. Underlying role scope: `self:write`. ### mentorship.leave Write · Leave a mentorship program as a mentor or mentee Exact permission: `mentorship.leave`. Underlying role scope: `self:write`. ## mentorship.checkIns ### mentorship.checkIns.answer Write · Answer whether you met your mentor or mentee, and whether it helped Exact permission: `mentorship.checkIns.answer`. Underlying role scope: `self:write`. ## mentorship.goals ### mentorship.goals.remove Write · Remove a goal from your mentorship, as the mentee Exact permission: `mentorship.goals.remove`. Underlying role scope: `self:write`. ### mentorship.goals.save Write · Add, rename or check off a goal in your mentorship, as the mentee Exact permission: `mentorship.goals.save`. Underlying role scope: `self:write`. ## mentorship.members ### mentorship.members.setStatus Write · Take someone off a mentorship program, or put them back Exact permission: `mentorship.members.setStatus`. Underlying role scope: `mentorship:write`. ## mentorship.mentors ### mentorship.mentors.choose Write · Choose your mentor from the mentors Shuffl suggests, in a program where mentees choose Exact permission: `mentorship.mentors.choose`. Underlying role scope: `self:write`. ## mentorship.pairs ### mentorship.pairs.decide Write · Approve a suggested mentorship pair, which introduces them, or skip it Exact permission: `mentorship.pairs.decide`. Underlying role scope: `mentorship:write`. ### mentorship.pairs.end Write · End a mentorship pairing early Exact permission: `mentorship.pairs.end`. Underlying role scope: `mentorship:write`. ### mentorship.pairs.setMine Write · Pause, resume or end your own mentorship pairing Exact permission: `mentorship.pairs.setMine`. Underlying role scope: `self:write`. ### mentorship.pairs.suggest Write · Suggest a mentor outside their reporting line for every mentee still waiting Exact permission: `mentorship.pairs.suggest`. Underlying role scope: `mentorship:write`. ## mentorship.programs ### mentorship.programs.get Read · One mentorship program: who joined, the suggested pairs and whether pairs are meeting Exact permission: `mentorship.programs.get`. Underlying role scope: `mentorship:read`. ### mentorship.programs.list Read · List mentorship programs, with how many mentors, mentees and pairs each has Exact permission: `mentorship.programs.list`. Underlying role scope: `mentorship:read`. ### mentorship.programs.save Write · Create or change a mentorship program: who can join, how long pairings last and how often pairs check in Exact permission: `mentorship.programs.save`. Underlying role scope: `mentorship:write`. ### mentorship.programs.setStatus Write · Turn mentorship programs on, pause one, or archive one and end its pairs Exact permission: `mentorship.programs.setStatus`. Underlying role scope: `mentorship:write`. ## mentorship.requests ### mentorship.requests.answer Write · Accept or pass on a mentee who chose you as their mentor Exact permission: `mentorship.requests.answer`. Underlying role scope: `self:write`. ## mentorship.sessions ### mentorship.sessions.remove Write · Remove your notes from a mentorship meeting Exact permission: `mentorship.sessions.remove`. Underlying role scope: `self:write`. ### mentorship.sessions.save Write · Add or change your notes from a mentorship meeting: what you talked about and one thing to try Exact permission: `mentorship.sessions.save`. Underlying role scope: `self:write`. ## mentorship.settings ### mentorship.settings.get Read · What a new mentorship program starts with: pairing length, check-in cadence and mentees per mentor Exact permission: `mentorship.settings.get`. Underlying role scope: `mentorship:read`. ### mentorship.settings.save Write · Change what a new mentorship program starts with; existing programs keep their own terms Exact permission: `mentorship.settings.save`. Underlying role scope: `mentorship:write`. ## network ### network.introductions Read · Your Connections programs, when your next introduction goes out, and who you met Exact permission: `network.introductions`. Underlying role scope: `users:read`. ### network.mine Read · Who you know and who you should meet Exact permission: `network.mine`. Underlying role scope: `users:read`. ### network.ofPerson Read · People you and this person both know Exact permission: `network.ofPerson`. Underlying role scope: `users:read`. ### network.orgChart Read · Everyone in the team with their manager, for the org chart Exact permission: `network.orgChart`. Underlying role scope: `users:read`. ### network.claim Write · Say you know someone or would like to meet them Exact permission: `network.claim`. Underlying role scope: `profile:write`. ### network.requestIntro Write · Ask someone you both know to introduce you Exact permission: `network.requestIntro`. Underlying role scope: `profile:write`. ## notifications ### notifications.preferences Read · Read your notification preferences Exact permission: `notifications.preferences`. Underlying role scope: `self:read`. ### notifications.save Write · Save a notification preference Exact permission: `notifications.save`. Underlying role scope: `self:write`. ## operations ### operations.activity Read · Read the workspace's recent audit activity Exact permission: `operations.activity`. Underlying role scope: `operations:read`. ### operations.status Read · Read the workspace delivery and provider health summary Exact permission: `operations.status`. Underlying role scope: `operations:read`. ### operations.dispatchInbox Write · Resume already-admitted team provider events and support delivery Exact permission: `operations.dispatchInbox`. Underlying role scope: `operations:write`. ### operations.reconcile Write · Reconcile an externally verified delivery outcome Exact permission: `operations.reconcile`. Underlying role scope: `operator:write`. ## permissions ### permissions.list Read · Discover available and granted permissions Intrinsic metadata permission; current authorization still applies. ## playbooks ### playbooks.buddyCandidates Read · Suggested buddies for a new hire: outside their reporting line, volunteers first, with how many hires each is buddying Exact permission: `playbooks.buddyCandidates`. Underlying role scope: `playbooks:read`. ### playbooks.buddyFollowUps Read · Your "did you meet?" questions about a new hire or buddy you were paired with Exact permission: `playbooks.buddyFollowUps`. Underlying role scope: `self:read`. ### playbooks.buddyProgram Read · Buddy volunteers and recent buddies, with how many of their hires said they met and how many never did Exact permission: `playbooks.buddyProgram`. Underlying role scope: `playbooks:read`. ### playbooks.buddySuggestions Read · Suggest coworkers who could be your onboarding buddy Exact permission: `playbooks.buddySuggestions`. Underlying role scope: `self:read`. ### playbooks.candidates Read · List people who could be enrolled in onboarding Exact permission: `playbooks.candidates`. Underlying role scope: `playbooks:read`. ### playbooks.enrollmentPreview Read · Preview enrolling a new hire in onboarding Exact permission: `playbooks.enrollmentPreview`. Underlying role scope: `playbooks:read`. ### playbooks.firstDaysCheckIns Read · Your open 30, 60 or 90-day or one-year new hire check-in Exact permission: `playbooks.firstDaysCheckIns`. Underlying role scope: `self:read`. ### playbooks.firstDaysResults Read · What new hires said in their first 90 days check-ins, combined Exact permission: `playbooks.firstDaysResults`. Underlying role scope: `playbooks:read`. ### playbooks.mine Read · Read your own onboarding plan and buddy asks Exact permission: `playbooks.mine`. Underlying role scope: `self:read`. ### playbooks.person Read · Read a new hire's onboarding plan Exact permission: `playbooks.person`. Underlying role scope: `playbooks:read`. ### playbooks.plans Read · The 30/60/90 plans for new hires you manage, and your own once your manager shares it Exact permission: `playbooks.plans`. Underlying role scope: `self:read`. ### playbooks.previewAs Read · Which steps of a playbook one person would get, on which day, and why each skipped step is left out Exact permission: `playbooks.previewAs`. Underlying role scope: `playbooks:read`. ### playbooks.program Read · Read the Onboarding program settings Exact permission: `playbooks.program`. Underlying role scope: `playbooks:read`. ### playbooks.run Read · One of your playbooks (onboarding or another): day 0, buddy, manager, upcoming check-ins, your to-dos and resources, and the other playbooks you are on Exact permission: `playbooks.run`. Underlying role scope: `self:read`. ### playbooks.answerBuddyAsk Write · Say yes or not now to being a new hire’s onboarding buddy Exact permission: `playbooks.answerBuddyAsk`. Underlying role scope: `self:write`. ### playbooks.answerBuddyFollowUp Write · Answer whether you met your buddy or new hire, and whether it helped Exact permission: `playbooks.answerBuddyFollowUp`. Underlying role scope: `self:write`. ### playbooks.answerCheckIn Write · Answer your onboarding program’s help check-in: all good, or ask HR for help Exact permission: `playbooks.answerCheckIn`. Underlying role scope: `self:write`. ### playbooks.answerFirstDaysCheckIn Write · Answer your new-hire check-in Exact permission: `playbooks.answerFirstDaysCheckIn`. Underlying role scope: `self:write`. ### playbooks.answerForm Write · Answer a playbook’s Tell us about you form; the answers fill in your profile Exact permission: `playbooks.answerForm`. Underlying role scope: `self:write`. ### playbooks.approve Write · Approve these exact playbook messages for sending Exact permission: `playbooks.approve`. Underlying role scope: `playbooks:write`. ### playbooks.askBuddy Write · Ask this coworker to be your onboarding buddy Exact permission: `playbooks.askBuddy`. Underlying role scope: `self:write`. ### playbooks.assignBuddy Write · Assign an onboarding buddy to a new hire Exact permission: `playbooks.assignBuddy`. Underlying role scope: `playbooks:write`. ### playbooks.completeTodo Write · Check off (or reopen) one of your own playbook to-dos Exact permission: `playbooks.completeTodo`. Underlying role scope: `self:write`. ### playbooks.draftPlan Write · Have Mello draft the 30/60/90 plan for a new hire you manage (not yet shared) Exact permission: `playbooks.draftPlan`. Underlying role scope: `self:write`. ### playbooks.enroll Write · Put this person on a playbook Exact permission: `playbooks.enroll`. Underlying role scope: `playbooks:write`. ### playbooks.nudge Write · Send someone one Slack nudge about a hire’s overdue playbook to-dos, at most once a day Exact permission: `playbooks.nudge`. Underlying role scope: `playbooks:write`. ### playbooks.previewEnrollment Write · Preview the onboarding steps for a new hire Exact permission: `playbooks.previewEnrollment`. Underlying role scope: `playbooks:write`. ### playbooks.remove Write · Remove a new hire from onboarding Exact permission: `playbooks.remove`. Underlying role scope: `playbooks:write`. ### playbooks.respondBuddy Write · Accept or decline being an onboarding buddy Exact permission: `playbooks.respondBuddy`. Underlying role scope: `self:write`. ### playbooks.retry Write · Retry a failed onboarding step Exact permission: `playbooks.retry`. Underlying role scope: `playbooks:write`. ### playbooks.savePlan Write · Write the goals of the 30/60/90 plan for a new hire you manage Exact permission: `playbooks.savePlan`. Underlying role scope: `self:write`. ### playbooks.saveProgram Write · Save a playbook: its day 0, steps and messages Exact permission: `playbooks.saveProgram`. Underlying role scope: `playbooks:write`. ### playbooks.setBuddyVolunteer Write · Put someone on the buddy volunteer list, take them off it, or clear it Exact permission: `playbooks.setBuddyVolunteer`. Underlying role scope: `playbooks:write`. ### playbooks.setPlanGoal Write · Tick a goal on a shared 30/60/90 plan done, or not done Exact permission: `playbooks.setPlanGoal`. Underlying role scope: `self:write`. ### playbooks.sharePlan Write · Share the 30/60/90 plan with the new hire you manage Exact permission: `playbooks.sharePlan`. Underlying role scope: `self:write`. ### playbooks.update Write · Change a new hire's onboarding start date or time zone Exact permission: `playbooks.update`. Underlying role scope: `playbooks:write`. ### playbooks.volunteerAsBuddy Write · Say you are happy to be an onboarding buddy, or stop Exact permission: `playbooks.volunteerAsBuddy`. Underlying role scope: `self:write`. ## praise ### praise.composer Read · Read who you can praise, the praise channels and company values Exact permission: `praise.composer`. Underlying role scope: `self:read`. ### praise.feed Read · Read the Praise feed Exact permission: `praise.feed`. Underlying role scope: `self:read`. ### praise.insights Read · Read Praise totals by value (groups of seven or more) Exact permission: `praise.insights`. Underlying role scope: `praise:read`. ### praise.mine Read · Read praise you gave and received Exact permission: `praise.mine`. Underlying role scope: `self:read`. ### praise.ofPerson Read · Read the public praise one person received Exact permission: `praise.ofPerson`. Underlying role scope: `self:read`. ### praise.settings Read · Read the Praise settings Exact permission: `praise.settings`. Underlying role scope: `praise:read`. ### praise.addChannel Write · Read praise from this Slack channel from now on Exact permission: `praise.addChannel`. Underlying role scope: `praise:write`. ### praise.removeChannel Write · Stop reading praise from a Slack channel Exact permission: `praise.removeChannel`. Underlying role scope: `praise:write`. ### praise.saveSettings Write · Save the Praise settings and company values Exact permission: `praise.saveSettings`. Underlying role scope: `praise:write`. ### praise.send Write · Praise coworkers in a praise channel Exact permission: `praise.send`. Underlying role scope: `self:write`. ### praise.setDigest Write · Choose whether you get the daily Praise digest Exact permission: `praise.setDigest`. Underlying role scope: `self:write`. ### praise.setHidden Write · Hide or show a praise you received Exact permission: `praise.setHidden`. Underlying role scope: `self:write`. ### praise.setRecognition Write · Choose whether praise for you is posted publicly or sent to you privately Exact permission: `praise.setRecognition`. Underlying role scope: `self:write`. ## profiles ### profiles.get Read · Read a person’s profile as this team sees it Exact permission: `profiles.get`. Underlying role scope: `users:read`. ### profiles.whoKnows Read · Find coworkers who know about a topic, place or skill from what they share on their profiles, with the words that matched Exact permission: `profiles.whoKnows`. Underlying role scope: `users:read`. ### profiles.draft Write · Draft the empty parts of your own profile with Mello; nothing is saved Exact permission: `profiles.draft`. Underlying role scope: `profile:write`. ### profiles.employeeNumber Write · Set a person’s employee number to an unused number Exact permission: `profiles.employeeNumber`. Underlying role scope: `users:write`. ### profiles.save Write · Save your own profile: pronouns, location, phone, bio, interests, links and what you are working on Exact permission: `profiles.save`. Underlying role scope: `profile:write`. ### profiles.settings Write · Choose who sees the optional parts of your own profile Exact permission: `profiles.settings`. Underlying role scope: `profile:write`. ## profiles.cover ### profiles.cover.delete Write · Remove your profile cover picture Exact permission: `profiles.cover.delete`. Underlying role scope: `profile:write`. ## profiles.photo ### profiles.photo.delete Write · Remove your profile photo Exact permission: `profiles.photo.delete`. Underlying role scope: `profile:write`. ## profiles.positions ### profiles.positions.delete Write · Remove a past position from your profile Exact permission: `profiles.positions.delete`. Underlying role scope: `profile:write`. ### profiles.positions.save Write · Add or change a past position on your profile Exact permission: `profiles.positions.save`. Underlying role scope: `profile:write`. ## programs ### programs.communities Read · List communities a Connections program can take its people from, with how many members show each one on their profile Exact permission: `programs.communities`. Underlying role scope: `programs:read`. ### programs.get Read · Read a program Exact permission: `programs.get`. Underlying role scope: `programs:read`. ### programs.list Read · List programs Exact permission: `programs.list`. Underlying role scope: `programs:read`. ### programs.options Read · List program setting choices Exact permission: `programs.options`. Underlying role scope: `programs:read`. ### programs.people Read · List the people in a program and whether they take part Exact permission: `programs.people`. Underlying role scope: `programs:read`. ### programs.preview Read · Preview matches without sending Exact permission: `programs.preview`. Underlying role scope: `programs:read`. ### programs.schedulePreview Read · Preview a program's upcoming rounds Exact permission: `programs.schedulePreview`. Underlying role scope: `programs:read`. ### programs.archive Write · Archive a program Exact permission: `programs.archive`. Underlying role scope: `programs:write`. ### programs.create Write · Create a program Exact permission: `programs.create`. Underlying role scope: `programs:write`. ### programs.joinChannel Write · Add Shuffl to this public Slack channel Exact permission: `programs.joinChannel`. Underlying role scope: `programs:write`. ### programs.pause Write · Pause a Connections program and its introductions Exact permission: `programs.pause`. Underlying role scope: `programs:write`. ### programs.resume Write · Activate a program and schedule Exact permission: `programs.resume`. Underlying role scope: `programs:write`. ### programs.syncRoster Write · Refresh channel membership Exact permission: `programs.syncRoster`. Underlying role scope: `programs:write`. ### programs.update Write · Update a program Exact permission: `programs.update`. Underlying role scope: `programs:write`. ## pulse ### pulse.actions Read · List Pulse actions: what is being done about each result, its owner, due date and before and after Exact permission: `pulse.actions`. Underlying role scope: `pulse:read`. ### pulse.asked Read · List the Pulse questions asked so far Exact permission: `pulse.asked`. Underlying role scope: `self:read`. ### pulse.groupTrends Read · Read each group's Pulse results over time, period by period, with the change since the start (published group totals only) Exact permission: `pulse.groupTrends`. Underlying role scope: `pulse:read`. ### pulse.insights Read · Read Pulse totals and trends (groups of seven or more) Exact permission: `pulse.insights`. Underlying role scope: `pulse:read`. ### pulse.latestRead Read · Read what stands out in a closed Pulse question’s result Exact permission: `pulse.latestRead`. Underlying role scope: `pulse:read`. ### pulse.mine Read · Read your own Pulse streak, how many took part, and what changed because of it Exact permission: `pulse.mine`. Underlying role scope: `self:read`. ### pulse.program Read · Read the Pulse settings Exact permission: `pulse.program`. Underlying role scope: `pulse:read`. ### pulse.proposals Read · List the Pulse questions Mello suggested that wait for approval Exact permission: `pulse.proposals`. Underlying role scope: `pulse:read`. ### pulse.questionDetail Read · Read one closed Pulse question: its answer spread, every time it was asked, and results by group (groups of seven or more) Exact permission: `pulse.questionDetail`. Underlying role scope: `pulse:read`. ### pulse.questions Read · List the Pulse question library Exact permission: `pulse.questions`. Underlying role scope: `pulse:read`. ### pulse.today Read · Read today’s Pulse question Exact permission: `pulse.today`. Underlying role scope: `self:read`. ### pulse.addQuestion Write · Add a Pulse question to the library Exact permission: `pulse.addQuestion`. Underlying role scope: `pulse:write`. ### pulse.addTemplate Write · Add a Pulse question set from a template Exact permission: `pulse.addTemplate`. Underlying role scope: `pulse:write`. ### pulse.answer Write · Answer today’s Pulse question as yourself Exact permission: `pulse.answer`. Underlying role scope: `self:write`. ### pulse.createAction Write · Plan an action about a closed Pulse question, with an owner and a due date Exact permission: `pulse.createAction`. Underlying role scope: `pulse:write`. ### pulse.decideProposal Write · Approve a suggested Pulse question so it is asked next, or dismiss it Exact permission: `pulse.decideProposal`. Underlying role scope: `pulse:write`. ### pulse.editProposal Write · Reword a suggested Pulse question before approving it Exact permission: `pulse.editProposal`. Underlying role scope: `pulse:write`. ### pulse.proposeQuestions Write · Save drafted Pulse questions as suggestions for HR to approve (never asked until approved) Exact permission: `pulse.proposeQuestions`. Underlying role scope: `pulse:write`. ### pulse.requestProposals Write · Ask Mello to suggest Pulse questions from recent results, optionally about a topic Exact permission: `pulse.requestProposals`. Underlying role scope: `pulse:write`. ### pulse.saveProgram Write · Save Pulse settings; enabling Pulse schedules questions to everyone Exact permission: `pulse.saveProgram`. Underlying role scope: `pulse:write`. ### pulse.setQuestionGroup Write · Aim a Pulse question at one of the workspace’s groups, or at everyone Exact permission: `pulse.setQuestionGroup`. Underlying role scope: `pulse:write`. ### pulse.setQuestionStatus Write · Retire or restore a Pulse question Exact permission: `pulse.setQuestionStatus`. Underlying role scope: `pulse:write`. ### pulse.skip Write · Skip today’s Pulse question Exact permission: `pulse.skip`. Underlying role scope: `self:write`. ### pulse.updateAction Write · Change a Pulse action’s wording, owner, due date or status Exact permission: `pulse.updateAction`. Underlying role scope: `pulse:write`. ## reminders ### reminders.mine Read · Read your own Praise and Pulse reminder choices Exact permission: `reminders.mine`. Underlying role scope: `self:read`. ### reminders.settings Read · Read whether Praise and Pulse reminders are on, and their timing Exact permission: `reminders.settings`. Underlying role scope: `team:read`. ### reminders.saveMine Write · Change or turn off your own Praise or Pulse reminders Exact permission: `reminders.saveMine`. Underlying role scope: `self:write`. ### reminders.saveSetting Write · Turn a Praise or Pulse reminder on or off, or change its timing Exact permission: `reminders.saveSetting`. Underlying role scope: `team:write`. ## reports ### reports.answerFeedback Read · Read feedback on Mello's answers Exact permission: `reports.answerFeedback`. Underlying role scope: `reports:read`. ### reports.celebrations Read · Celebrations sent, people celebrated, birthdays and anniversaries, shared with the team, team cards and notes, share answers and missed messages over 30, 90 or 180 days against the period before, with a weekly series Exact permission: `reports.celebrations`. Underlying role scope: `reports:read`. ### reports.connections Read · Read Connections insights Exact permission: `reports.connections`. Underlying role scope: `reports:read`. ### reports.knowledge Read · Read Knowledge activity Exact permission: `reports.knowledge`. Underlying role scope: `reports:read`. ### reports.knowledgeSource Read · Read activity for one Knowledge source Exact permission: `reports.knowledgeSource`. Underlying role scope: `reports:read`. ### reports.melloTrial Read · What Mello handled during the trial, from day 25 of a trial until it ends Exact permission: `reports.melloTrial`. Underlying role scope: `reports:read`. ### reports.melloValue Read · What Mello handled this week, this month and all time, with time saved once the team has set its minutes per question Exact permission: `reports.melloValue`. Underlying role scope: `reports:read`. ### reports.mentorship Read · Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. Never goals Exact permission: `reports.mentorship`. Underlying role scope: `reports:read`. ### reports.needsYou Read · Read HR request and Knowledge draft insights Exact permission: `reports.needsYou`. Underlying role scope: `reports:read`. ### reports.overview Read · Read the workspace overview figures Exact permission: `reports.overview`. Underlying role scope: `reports:read`. ### reports.people Read · Read People insights: headcount, teams and growth Exact permission: `reports.people`. Underlying role scope: `reports:read`. ### reports.playbooks Read · Read Onboarding insights Exact permission: `reports.playbooks`. Underlying role scope: `reports:read`. ## runs ### runs.details Read · Read one introduction round and its pairs Exact permission: `runs.details`. Underlying role scope: `runs:read`. ### runs.get Read · Read a run status Exact permission: `runs.get`. Underlying role scope: `runs:read`. ### runs.list Read · List a program's introduction rounds Exact permission: `runs.list`. Underlying role scope: `runs:read`. ### runs.dispatch Write · Dispatch this queued introduction run Exact permission: `runs.dispatch`. Underlying role scope: `runs:write`. ### runs.request Write · Request introductions from a preview Exact permission: `runs.request`. Underlying role scope: `runs:write`. ### runs.retry Write · Retry introduction delivery Exact permission: `runs.retry`. Underlying role scope: `runs:write`. ### runs.stopKnownFailures Write · Stop retrying known failed deliveries and advance the preserved monthly schedule Exact permission: `runs.stopKnownFailures`. Underlying role scope: `runs:write`. ## runs.history ### runs.history.get Read · Read one introduction round imported from the previous Shuffl Exact permission: `runs.history.get`. Underlying role scope: `exports:read`. ### runs.history.list Read · List introduction rounds imported from the previous Shuffl Exact permission: `runs.history.list`. Underlying role scope: `exports:read`. ## support ### support.get Read · Read one Shuffl support conversation Exact permission: `support.get`. Underlying role scope: `support:read`. ### support.list Read · List the workspace's support conversations with Shuffl Exact permission: `support.list`. Underlying role scope: `support:read`. ### support.assign Write · Assign a Shuffl support conversation Exact permission: `support.assign`. Underlying role scope: `support:write`. ### support.close Write · Close a Shuffl support conversation Exact permission: `support.close`. Underlying role scope: `support:write`. ### support.create Write · Start a support conversation with Shuffl Exact permission: `support.create`. Underlying role scope: `support:write`. ### support.reply Write · Reply in a Shuffl support conversation Exact permission: `support.reply`. Underlying role scope: `support:write`. ## sync ### sync.current Read · Read the People sync provider, its last sync and what it found Exact permission: `sync.current`. Underlying role scope: `integrations:read`. ### sync.groups Read · List this source’s groups and which ones come into Shuffl Exact permission: `sync.groups`. Underlying role scope: `integrations:read`. ### sync.connect Write · Connect a directory sync provider with the credential given Exact permission: `sync.connect`. Underlying role scope: `integrations:write`. ### sync.disconnect Write · Disconnect this directory sync provider Exact permission: `sync.disconnect`. Underlying role scope: `integrations:write`. ### sync.request Write · Ask for a People sync provider Shuffl does not support yet Exact permission: `sync.request`. Underlying role scope: `integrations:write`. ### sync.run Write · Sync People from the connected provider now Exact permission: `sync.run`. Underlying role scope: `integrations:write`. ### sync.setGroup Write · Change which of this source’s groups come into Shuffl Exact permission: `sync.setGroup`. Underlying role scope: `integrations:write`. ### sync.setWrites Write · Let Mello file requests in this source, or stop it Exact permission: `sync.setWrites`. Underlying role scope: `integrations:write`. ## team ### team.launchPost Read · Read the launch announcement for the workspace Exact permission: `team.launchPost`. Underlying role scope: `team:read`. ### team.answerMinutes Write · Set the team estimate of minutes per HR question, used for time saved Exact permission: `team.answerMinutes`. Underlying role scope: `team:write`. ### team.dismissLaunchPost Write · Dismiss the Tell your team what they can ask post on Today for everyone Exact permission: `team.dismissLaunchPost`. Underlying role scope: `team:write`. ## teams ### teams.connectionPermissions Read · List connections whose permissions are behind what Shuffl asks for Exact permission: `teams.connectionPermissions`. Underlying role scope: `team:read`. ### teams.current Read · Read this token’s team Intrinsic metadata permission; current authorization still applies. ### teams.setup Read · Read the workspace's setup checklist Exact permission: `teams.setup`. Underlying role scope: `team:read`. ### teams.slackChannels Read · List community channels in the connected Slack and what each would become Exact permission: `teams.slackChannels`. Underlying role scope: `integrations:read`. ### teams.slackConnection Read · Read whether the workspace's Slack is connected, and why not Exact permission: `teams.slackConnection`. Underlying role scope: `integrations:read`. ### teams.slackJoinAccess Read · Read whether Slack members can join Shuffl on their own Exact permission: `teams.slackJoinAccess`. Underlying role scope: `team:read`. ### teams.slackProfileLink Read · Read the Shuffl profile link setting for Slack profiles Exact permission: `teams.slackProfileLink`. Underlying role scope: `team:read`. ### teams.discardPairHistory Write · Remove this staged past-intros report Exact permission: `teams.discardPairHistory`. Underlying role scope: `integrations:write`. ### teams.initialize Write · Finish setting up a new workspace Exact permission: `teams.initialize`. Underlying role scope: `team:write`. ### teams.moveSlackChannels Write · Set up each channel in Shuffl: paused intros, praise and celebrations Exact permission: `teams.moveSlackChannels`. Underlying role scope: `integrations:write`. ### teams.rename Write · Rename the workspace Exact permission: `teams.rename`. Underlying role scope: `team:write`. ### teams.resendSlackWelcome Write · Send the Slack install welcome to your own Slack DM again Exact permission: `teams.resendSlackWelcome`. Underlying role scope: `integrations:write`. ### teams.saveAgentSetup Write · Choose the built-in assistant or an external agent for the workspace Exact permission: `teams.saveAgentSetup`. Underlying role scope: `team:write`. ### teams.saveSlackJoinAccess Write · Choose whether Slack members can join Shuffl on their own Exact permission: `teams.saveSlackJoinAccess`. Underlying role scope: `team:write`. ### teams.saveSlackProfileLink Write · Turn the Shuffl profile link on Slack profiles on or off Exact permission: `teams.saveSlackProfileLink`. Underlying role scope: `team:write`. ### teams.status Write · Pause or resume the whole workspace Exact permission: `teams.status`. Underlying role scope: `team:write`. ### teams.syncSlackProfileLinks Write · Write the Shuffl profile link to every Slack profile again Exact permission: `teams.syncSlackProfileLinks`. Underlying role scope: `team:write`. ### teams.uploadPairHistory Write · Stage this past-intros report for the switch; nothing changes until it is applied Exact permission: `teams.uploadPairHistory`. Underlying role scope: `integrations:write`. ## timeOff ### timeOff.balances Read · Read your own time-off balances from the connected HR system Exact permission: `timeOff.balances`. Underlying role scope: `self:read`. ## units ### units.list Read · List the departments in the People directory Exact permission: `units.list`. Underlying role scope: `users:read`. ## users ### users.activity Read · Read a person's recent activity in Shuffl Exact permission: `users.activity`. Underlying role scope: `users:read`. ### users.blockedPairs Read · List pairs of people who are never introduced Exact permission: `users.blockedPairs`. Underlying role scope: `users:read`. ### users.details Read · Read one person's People directory record Exact permission: `users.details`. Underlying role scope: `users:read`. ### users.filterOptions Read · List the teams, departments, managers and locations People can filter by Exact permission: `users.filterOptions`. Underlying role scope: `users:read`. ### users.get Read · Read a person Exact permission: `users.get`. Underlying role scope: `users:read`. ### users.glance Read · Headcount, growth, departments, tenure and time zones, and where you fit Exact permission: `users.glance`. Underlying role scope: `users:read`. ### users.list Read · List people Exact permission: `users.list`. Underlying role scope: `users:read`. ### users.managerHistory Read · Read a person's recorded manager history Exact permission: `users.managerHistory`. Underlying role scope: `users:read`. ### users.managers Read · List the managers in the People directory Exact permission: `users.managers`. Underlying role scope: `users:read`. ### users.page Read · List people in the People directory: search, or filter by team, department, manager, location, access or workspace role such as owner, admin or HR responder Exact permission: `users.page`. Underlying role scope: `users:read`. ### users.participants Read · List the people who take part in programs Exact permission: `users.participants`. Underlying role scope: `users:read`. ### users.reportingLineProposal Read · Read the reporting lines Mello proposed that wait for review Exact permission: `users.reportingLineProposal`. Underlying role scope: `users:read`. ### users.assignManagers Write · Set the manager of several people at once Exact permission: `users.assignManagers`. Underlying role scope: `users:write`. ### users.blockPair Write · Stop two people from being introduced to each other Exact permission: `users.blockPair`. Underlying role scope: `users:write`. ### users.participation Write · Opt a person in to or out of a program Exact permission: `users.participation`. Underlying role scope: `participation:write`. ### users.profile Write · Edit a person's profile as an administrator Exact permission: `users.profile`. Underlying role scope: `profile:write`. ### users.proposeReportingLines Write · Ask Mello to propose managers for people without one; nothing changes until reviewed Exact permission: `users.proposeReportingLines`. Underlying role scope: `users:write`. ### users.reviewReportingLines Write · Approve chosen proposed reporting lines and close the proposal Exact permission: `users.reviewReportingLines`. Underlying role scope: `users:write`. ### users.save Write · Change someone's People directory record as an administrator: name, job title, manager, team, department or start date Exact permission: `users.save`. Underlying role scope: `users:write`. ## webhooks ### webhooks.catalog Read · List the webhook event types and which ones this key can subscribe to Exact permission: `webhooks.catalog`. Underlying role scope: `webhooks:read`. ### webhooks.get Read · Read one webhook endpoint Exact permission: `webhooks.get`. Underlying role scope: `webhooks:read`. ### webhooks.list Read · List webhook endpoints, their status and delivery success over 24 hours Exact permission: `webhooks.list`. Underlying role scope: `webhooks:read`. ### webhooks.create Write · Add a webhook endpoint that receives the chosen events, and get its signing secret Exact permission: `webhooks.create`. Underlying role scope: `webhooks:write`. ### webhooks.delete Write · Delete a webhook endpoint and its delivery log Exact permission: `webhooks.delete`. Underlying role scope: `webhooks:write`. ### webhooks.rotateSecret Write · Roll a webhook endpoint’s signing secret, keeping the old one valid for a while Exact permission: `webhooks.rotateSecret`. Underlying role scope: `webhooks:write`. ### webhooks.sendTest Write · Send a webhook.test event to an endpoint now Exact permission: `webhooks.sendTest`. Underlying role scope: `webhooks:write`. ### webhooks.update Write · Change a webhook endpoint’s URL, description or events, or turn it on or off Exact permission: `webhooks.update`. Underlying role scope: `webhooks:write`. ## webhooks.deliveries ### webhooks.deliveries.get Read · Read one webhook delivery: the request body and every attempt’s answer Exact permission: `webhooks.deliveries.get`. Underlying role scope: `webhooks:read`. ### webhooks.deliveries.list Read · List an endpoint’s webhook deliveries, newest first Exact permission: `webhooks.deliveries.list`. Underlying role scope: `webhooks:read`. ### webhooks.deliveries.replay Write · Resend one webhook delivery with the same event id Exact permission: `webhooks.deliveries.replay`. Underlying role scope: `webhooks:write`. ### webhooks.deliveries.replayFailed Write · Resend every failed webhook delivery of an endpoint since a time Exact permission: `webhooks.deliveries.replayFailed`. Underlying role scope: `webhooks:write`. ## Related guides - [REST API reference](https://shuffl.ai/docs/api-reference) - [Use the SDK and HTTP API](https://shuffl.ai/docs/sdk) - [Use the Shuffl CLI](https://shuffl.ai/docs/cli) - [Connect an MCP client](https://shuffl.ai/docs/mcp) Agent documentation index: https://shuffl.ai/llms.txt