API endpoint permissions

Choose Read and Write grants and look up the permission ID for every supported API operation.

Administrators and integration developers

Read as Markdown All guides as text Agent documentation index

App links open your signed-in workspace. Check the selected workspace before making changes.

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. Grants don’t imply each other: users.list doesn’t grant users.get, units.save doesn’t grant units.list or units.archive, and Write never includes Read.

teams.current and permissions.list are always readable by an authenticated, authorized API key. Every other operation needs an exact grant plus current tenant, membership, role, employee-access and resource checks. The catalog can include operations your role or deployment doesn’t offer.

To see what you can grant and what you’ve been granted, use permissions.list in the SDK, GET /api/v1/permissions or shuffl permissions list --json. This reference lists operation definitions only.

Revocation, replacement and delegation

Grants are fixed when a key is issued. To change them, create a replacement key and revoke the old one. Revocation and expiry also invalidate keys issued from it. New endpoints don’t become available to an existing key.

Creating a credential through the SDK, API or CLI takes permissions: ["users.list"]. A delegated issuer must hold credentials.api.create and every permission it grants, and the grants must fit within the parent and all its ancestors. Delegation goes at most three generations deep and can’t outlive its parent.

MCP access is the mcp.knowledge permission, checked by the MCP server rather than an HTTP endpoint. A key with credentials.api.create can delegate it only if it holds mcp.knowledge itself. API permissions don’t grant browser sign-in, provider OAuth consent or access to another workspace.

access

access.get
Read · Read one person's workspace role and app access
Exact grant required. Underlying role scope: access:read.
access.slackWaiting
Read · List Slack members waiting for access to Shuffl
Exact grant required. Underlying role scope: access:read.
access.enableSlack
Write · Give these Slack people employee access
Exact grant required. Underlying role scope: access:write.
access.save
Write · Change employee product access
Exact grant required. Underlying role scope: access:write.
access.saveRole
Write · Change a member’s team role
Exact grant required. Underlying role scope: access:write.

assistant

assistant.conversations
Read · List your conversations with Mello
Exact grant required. Underlying role scope: assistant:read.
assistant.history
Read · Read the messages in one of your conversations with Mello
Exact grant required. Underlying role scope: assistant:read.
assistant.delete
Write · Delete one of your conversations with Mello
Exact grant required. Underlying role scope: assistant:write.
assistant.send
Write · Ask Mello a question in a conversation
Exact grant required. Underlying role scope: assistant:write.
assistant.stop
Write · Stop an answer Mello is still writing
Exact grant required. Underlying role scope: assistant:write.

badges

badges.holders
Read · List the people who hold a badge, as far as each lets you see
Exact grant required. Underlying role scope: users:read.
badges.list
Read · List the team’s badges, who holds them and any open requests you decide
Exact grant required. Underlying role scope: users:read.
badges.ofPerson
Read · List a person's badges
Exact grant required. Underlying role scope: users:read.
badges.settings
Read · Read the badge suggestion settings
Exact grant required. Underlying role scope: praise:read.
badges.award
Write · Give a badge you own to a person
Exact grant required. Underlying role scope: profile:write.
badges.claim
Write · Claim a badge with its code
Exact grant required. Underlying role scope: profile:write.
badges.decideRequest
Write · Approve or decline a request for a badge
Exact grant required. 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 grant required. Underlying role scope: profile:write.
badges.hideOwn
Write · Hide or show one of your badges on your profile
Exact grant required. Underlying role scope: profile:write.
badges.request
Write · Ask for a badge
Exact grant required. Underlying role scope: profile:write.
badges.revoke
Write · Take a badge back from a person
Exact grant required. Underlying role scope: profile:write.
badges.save
Write · Create or edit a badge you own
Exact grant required. Underlying role scope: profile:write.
badges.saveSettings
Write · Turn badge offers from praise on or off, and choose the launch channel
Exact grant required. Underlying role scope: praise:write.
badges.setHidden
Write · Hide or show a badge for the whole workspace
Exact grant required. 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 grant required. Underlying role scope: profile:write.

celebrations

celebrations.card
Read · Open a celebration card you can sign or were given
Exact grant required. Underlying role scope: self:read.
celebrations.cards
Read · List celebration cards to sign and cards you were given
Exact grant required. Underlying role scope: self:read.
celebrations.deliveries
Read · List the celebration messages Shuffl sent
Exact grant required. Underlying role scope: celebrations:read.
celebrations.mine
Read · List the celebrations you received
Exact grant required. Underlying role scope: self:read.
celebrations.preferences
Read · Read your birthday and work anniversary sharing preferences
Exact grant required. Underlying role scope: self:read.
celebrations.preview
Read · Preview a celebration message
Exact grant required. Underlying role scope: celebrations:read.
celebrations.program
Read · Read the Celebrations settings
Exact grant required. Underlying role scope: celebrations:read.
celebrations.review
Read · Review upcoming birthdays and work anniversaries
Exact grant required. Underlying role scope: celebrations:read.
celebrations.refresh
Write · Look for new birthdays and work anniversaries to celebrate now
Exact grant required. Underlying role scope: celebrations:write.
celebrations.removeCardNote
Write · Remove your note from this celebration card
Exact grant required. Underlying role scope: self:write.
celebrations.save
Write · Save celebration settings; enabling them schedules messages
Exact grant required. Underlying role scope: celebrations:write.
celebrations.savePreferences
Write · Save your birthday and work anniversary sharing preferences
Exact grant required. Underlying role scope: self:write.
celebrations.signCard
Write · Sign this celebration card with your note
Exact grant required. Underlying role scope: self:write.

channels

channels.list
Read · List available Slack channels
Exact grant required. Underlying role scope: programs:read.

commands

commands.get
Read · Read your own command receipt
Exact grant required. Underlying role scope: null.

communities

communities.channelSuggestions
Read · List Slack channels, with the ones that look like communities suggested
Exact grant required. Underlying role scope: programs:read.
communities.createCapabilities
Read · Read the current permission to create public or private community channels
Exact grant required. Underlying role scope: programs:read.
communities.list
Read · List communities with the members you may see
Exact grant required. Underlying role scope: users:read.
communities.members
Read · List a community's members
Exact grant required. Underlying role scope: users:read.
communities.ofPerson
Read · List the communities a person belongs to
Exact grant required. Underlying role scope: users:read.
communities.archive
Write · Archive a community
Exact grant required. 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 grant required. Underlying role scope: programs:write.
communities.fromChannels
Write · Create one community per chosen Slack channel, as an administrator
Exact grant required. 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 grant required. Underlying role scope: profile:write.
communities.invite
Write · Invite selected people to a community as its owner or administrator; each person must accept
Exact grant required. Underlying role scope: profile:write.
communities.join
Write · Join a community
Exact grant required. Underlying role scope: profile:write.
communities.leave
Write · Leave a community
Exact grant required. Underlying role scope: profile:write.
communities.removeMember
Write · Remove someone from a community, as its owner or moderator
Exact grant required. Underlying role scope: profile:write.
communities.revokeInvitation
Write · Revoke a pending community invitation as its owner or administrator
Exact grant required. Underlying role scope: profile:write.
communities.save
Write · Create or edit a community, optionally tied to a Slack channel
Exact grant required. Underlying role scope: profile:write.
communities.setVisibility
Write · Show or hide a community on your profile
Exact grant required. Underlying role scope: profile:write.
communities.sync
Write · Sync a community's members with its Slack channel now
Exact grant required. 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 grant required. Underlying role scope: profile:write.

credentials.api

credentials.api.list
Read · List the workspace's API keys and what each can do
Exact grant required. Underlying role scope: credentials:read.
credentials.api.create
Write · Delegate a subset of this credential with bounded expiry and inherited revocation
Exact grant required. Underlying role scope: credentials:write.
credentials.api.revoke
Write · Revoke an API key
Exact grant required. Underlying role scope: credentials:write.

digest

digest.nudge
Read · Read one of Mello’s culture nudges
Exact grant required. Underlying role scope: reports:read.
digest.nudges
Read · List Mello’s culture nudges for the workspace
Exact grant required. Underlying role scope: reports:read.
digest.preview
Read · Preview the HR digest for the last period
Exact grant required. Underlying role scope: reports:read.
digest.settings
Read · Read the HR digest schedule
Exact grant required. Underlying role scope: team:read.
digest.actOnNudge
Write · Record that a culture nudge was acted on and get where its action goes
Exact grant required. Underlying role scope: team:write.
digest.dismissNudge
Write · Dismiss a culture nudge for 90 days
Exact grant required. Underlying role scope: team:write.
digest.saveSettings
Write · Save the HR digest schedule and admin channel
Exact grant required. Underlying role scope: team:write.

exports

exports.team
Read · Export the workspace's programs, people and introduction history
Exact grant required. Underlying role scope: exports:read.

getStarted

getStarted.celebration
Read · Read the first-action celebration waiting for you, if any
Exact grant required. Underlying role scope: self:read.
getStarted.get
Read · Read your own Get started steps and whether the welcome still shows
Exact grant required. Underlying role scope: self:read.
getStarted.celebrate
Write · Record that a celebration was shown, shared or dismissed
Exact grant required. Underlying role scope: profile:write.
getStarted.dismiss
Write · Hide the Get started card
Exact grant required. Underlying role scope: profile:write.
getStarted.draftIntro
Write · Draft a short hello to your coworkers with Mello; nothing is posted
Exact grant required. Underlying role scope: profile:write.
getStarted.intro
Write · Post your hello on Home, or skip it
Exact grant required. Underlying role scope: profile:write.
getStarted.wizard
Write · Record that you opened, finished or skipped the welcome
Exact grant required. Underlying role scope: profile:write.

home

home.feed
Read · What happened to people you know, and who Mello thinks you should meet
Exact grant required. Underlying role scope: self:read.
home.preferences
Write · Choose how Home looks: cards or compact, stories, autoplay, For you
Exact grant required. Underlying role scope: profile:write.
home.react
Write · Add or remove your emoji reaction on a Home moment
Exact grant required. Underlying role scope: profile:write.
home.story
Write · Record Home stories you opened, sent a note from, or skipped
Exact grant required. Underlying role scope: profile:write.

hr

hr.categories
Read · Read the HR request categories and response target
Exact grant required. Underlying role scope: hr:read.
hr.get
Read · Read one HR request and its messages
Exact grant required. Underlying role scope: hr:read.
hr.list
Read · List the HR requests you asked or can answer
Exact grant required. Underlying role scope: hr:read.
hr.readiness
Read · Check whether HR requests have a destination and someone to answer them
Exact grant required. Underlying role scope: hr:read.
hr.settings
Read · Read the HR team name and who answers HR requests
Exact grant required. Underlying role scope: hr:read.
hr.shareSources
Read · List your recent Mello conversations that an HR request can include
Exact grant required. Underlying role scope: hr:read.
hr.command
Write · Claim, release, reply to, note, categorize, resolve or reopen an HR request
Exact grant required. Underlying role scope: hr:write.
hr.configure
Write · Change the HR request destination
Exact grant required. Underlying role scope: hr:write.
hr.deliver
Write · Deliver your HR reply to the employee
Exact grant required. Underlying role scope: hr:write.
hr.rebuildCategories
Write · Have Mello rebuild the HR request categories from published Knowledge
Exact grant required. Underlying role scope: hr:write.
hr.renameTeam
Write · Rename the HR team employees send requests to
Exact grant required. Underlying role scope: hr:write.
hr.retryDelivery
Write · Retry HR request delivery
Exact grant required. Underlying role scope: hr:write.
hr.saveCategories
Write · Save the HR request categories, their owners and the response target
Exact grant required. Underlying role scope: hr:write.
hr.share
Write · Share this request with the selected HR responders
Exact grant required. Underlying role scope: hr:write.

identities

identities.list
Read · List the Slack and web accounts linked to a person
Exact grant required. Underlying role scope: identities:read.
identities.slackAccounts
Read · List Slack accounts that can be linked to people
Exact grant required. Underlying role scope: identities:read.
identities.webAccounts
Read · List web accounts that can be linked to people
Exact grant required. Underlying role scope: identities:read.
identities.linkSlack
Write · Link a verified Slack account
Exact grant required. Underlying role scope: identities:write.
identities.linkWeb
Write · Link a verified web account
Exact grant required. Underlying role scope: identities:write.
identities.unlink
Write · Revoke an employee identity link
Exact grant required. Underlying role scope: identities:write.

integrations

integrations.authorize
Read · Get the link that connects Slack, Google Drive or Notion to the workspace
Exact grant required. Underlying role scope: integrations:write.

invitations

invitations.candidates
Read · List people in the directory who can be invited to the workspace
Exact grant required. Underlying role scope: access:read.
invitations.list
Read · List pending workspace invitations
Exact grant required. Underlying role scope: access:read.
invitations.cancel
Write · Cancel a pending workspace invitation
Exact grant required. Underlying role scope: access:write.
invitations.create
Write · Invite this person with the selected team role
Exact grant required. Underlying role scope: access:write.
invitations.createMany
Write · Invite these people with the selected team role
Exact grant required. Underlying role scope: access:write.
invitations.inviteDirectory
Write · Invite everyone in the directory who is not invited yet
Exact grant required. Underlying role scope: access:write.

knowledge

knowledge.context
Read · Read nearby approved passages
Exact grant required. Underlying role scope: knowledge:read.
knowledge.search
Read · Search approved knowledge
Exact grant required. Underlying role scope: knowledge:read.

knowledge.connections

knowledge.connections.browse
Read · List documents a connected Knowledge source can see
Exact grant required. Underlying role scope: integrations:read.
knowledge.connections.list
Read · List connected Knowledge providers
Exact grant required. Underlying role scope: integrations:read.
knowledge.connections.requests
Read · List requests to connect a Knowledge source
Exact grant required. Underlying role scope: integrations:read.
knowledge.connections.connect
Write · Connect a Knowledge provider with a token
Exact grant required. Underlying role scope: integrations:write.
knowledge.connections.disconnect
Write · Disconnect a knowledge provider
Exact grant required. Underlying role scope: integrations:write.
knowledge.connections.request
Write · Ask an administrator to connect a Knowledge source
Exact grant required. Underlying role scope: integrations:write.

knowledge.policies

knowledge.policies.coverage
Read · Check which common HR policies Knowledge covers
Exact grant required. Underlying role scope: knowledge:manage.

knowledge.sources

knowledge.sources.get
Read · Read a Knowledge source
Exact grant required. Underlying role scope: knowledge:manage.
knowledge.sources.history
Read · List a Knowledge source's versions
Exact grant required. Underlying role scope: knowledge:manage.
knowledge.sources.list
Read · List Knowledge sources
Exact grant required. Underlying role scope: knowledge:manage.
knowledge.sources.search
Read · Search Knowledge sources by title
Exact grant required. Underlying role scope: knowledge:read.
knowledge.sources.archive
Write · Archive an unpublished knowledge source
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.changeAudience
Write · Change who can read this knowledge source
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.importConnected
Write · Import a document from a connected Knowledge source
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.importWebsite
Write · Import a website page into Knowledge for review
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.publish
Write · Publish this knowledge version to its audience
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.refresh
Write · Refresh a Knowledge source from its connected provider
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.restore
Write · Restore an archived knowledge source
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.save
Write · Save a Knowledge source draft
Exact grant required. Underlying role scope: knowledge:write.
knowledge.sources.withdraw
Write · Withdraw a published Knowledge source
Exact grant required. 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 grant required. Underlying role scope: knowledge:write.

knowledge.uploads

knowledge.uploads.get
Read · Read the progress of a Knowledge file upload
Exact grant required. Underlying role scope: knowledge:write.
knowledge.uploads.appendPart
Write · Upload the next part of a Knowledge file
Exact grant required. Underlying role scope: knowledge:write.
knowledge.uploads.complete
Write · Finish a Knowledge file upload and start reading it
Exact grant required. Underlying role scope: knowledge:write.
knowledge.uploads.create
Write · Start uploading a file to Knowledge
Exact grant required. Underlying role scope: knowledge:write.
knowledge.uploads.retry
Write · Retry reading a Knowledge file that failed
Exact grant required. Underlying role scope: knowledge:write.

manager

manager.current
Read · Read your own manager context
Exact grant required. Underlying role scope: manager:read.

mcp

mcp.knowledge
Read · Connect an agent over MCP
Exact grant required. Underlying role scope: knowledge:read.

network

network.mine
Read · Who you know and who you should meet
Exact grant required. Underlying role scope: users:read.
network.ofPerson
Read · People you and this person both know
Exact grant required. Underlying role scope: users:read.
network.orgChart
Read · Everyone in the team with their manager, for the org chart
Exact grant required. Underlying role scope: users:read.
network.claim
Write · Say you know someone or would like to meet them
Exact grant required. Underlying role scope: profile:write.

notifications

notifications.preferences
Read · Read your notification preferences
Exact grant required. Underlying role scope: self:read.
notifications.save
Write · Save a notification preference
Exact grant required. Underlying role scope: self:write.

onboarding

onboarding.buddySuggestions
Read · Suggest coworkers who could be your onboarding buddy
Exact grant required. Underlying role scope: self:read.
onboarding.candidates
Read · List people who could be enrolled in onboarding
Exact grant required. Underlying role scope: onboarding:read.
onboarding.enrollmentPreview
Read · Preview enrolling a new hire in onboarding
Exact grant required. Underlying role scope: onboarding:read.
onboarding.firstDaysCheckIns
Read · Your open 30, 60 or 90-day or one-year new hire check-in
Exact grant required. Underlying role scope: self:read.
onboarding.firstDaysResults
Read · What new hires said in their first 90 days check-ins, combined
Exact grant required. Underlying role scope: onboarding:read.
onboarding.mine
Read · Read your own onboarding plan and buddy asks
Exact grant required. Underlying role scope: self:read.
onboarding.person
Read · Read a new hire's onboarding plan
Exact grant required. Underlying role scope: onboarding:read.
onboarding.program
Read · Read the Onboarding program settings
Exact grant required. Underlying role scope: onboarding:read.
onboarding.answerBuddyAsk
Write · Say yes or not now to being a new hire’s onboarding buddy
Exact grant required. Underlying role scope: self:write.
onboarding.answerCheckIn
Write · Answer your onboarding program’s help check-in: all good, or ask HR for help
Exact grant required. Underlying role scope: self:write.
onboarding.answerFirstDaysCheckIn
Write · Answer your new-hire check-in
Exact grant required. Underlying role scope: self:write.
onboarding.approve
Write · Approve these exact onboarding messages for sending
Exact grant required. Underlying role scope: onboarding:write.
onboarding.askBuddy
Write · Ask this coworker to be your onboarding buddy
Exact grant required. Underlying role scope: self:write.
onboarding.assignBuddy
Write · Assign an onboarding buddy to a new hire
Exact grant required. Underlying role scope: onboarding:write.
onboarding.enroll
Write · Enroll this person in onboarding
Exact grant required. Underlying role scope: onboarding:write.
onboarding.previewEnrollment
Write · Preview the onboarding steps for a new hire
Exact grant required. Underlying role scope: onboarding:write.
onboarding.remove
Write · Remove a new hire from onboarding
Exact grant required. Underlying role scope: onboarding:write.
onboarding.respondBuddy
Write · Accept or decline being an onboarding buddy
Exact grant required. Underlying role scope: self:write.
onboarding.retry
Write · Retry a failed onboarding step
Exact grant required. Underlying role scope: onboarding:write.
onboarding.saveProgram
Write · Save the onboarding program and its messages
Exact grant required. Underlying role scope: onboarding:write.
onboarding.update
Write · Change a new hire's onboarding start date or time zone
Exact grant required. Underlying role scope: onboarding:write.

operations

operations.activity
Read · Read the workspace's recent audit activity
Exact grant required. Underlying role scope: operations:read.
operations.status
Read · Read the workspace delivery and provider health summary
Exact grant required. Underlying role scope: operations:read.
operations.dispatchInbox
Write · Resume already-admitted team provider events and support delivery
Exact grant required. Underlying role scope: operations:write.
operations.reconcile
Write · Reconcile an externally verified delivery outcome
Exact grant required. Underlying role scope: operator:write.

permissions

permissions.list
Read · Discover available and granted permissions
Intrinsic metadata permission; current authorization still applies.

praise

praise.composer
Read · Read who you can praise, the praise channels and company values
Exact grant required. Underlying role scope: self:read.
praise.feed
Read · Read the Praise feed
Exact grant required. Underlying role scope: self:read.
praise.insights
Read · Read Praise totals by value (groups of seven or more)
Exact grant required. Underlying role scope: praise:read.
praise.mine
Read · Read praise you gave and received
Exact grant required. Underlying role scope: self:read.
praise.ofPerson
Read · Read the public praise one person received
Exact grant required. Underlying role scope: self:read.
praise.settings
Read · Read the Praise settings
Exact grant required. Underlying role scope: praise:read.
praise.addChannel
Write · Read praise from this Slack channel from now on
Exact grant required. Underlying role scope: praise:write.
praise.removeChannel
Write · Stop reading praise from a Slack channel
Exact grant required. Underlying role scope: praise:write.
praise.saveSettings
Write · Save the Praise settings and company values
Exact grant required. Underlying role scope: praise:write.
praise.send
Write · Praise coworkers in a praise channel
Exact grant required. Underlying role scope: self:write.
praise.setDigest
Write · Choose whether you get the daily Praise digest
Exact grant required. Underlying role scope: self:write.
praise.setHidden
Write · Hide or show a praise you received
Exact grant required. Underlying role scope: self:write.

profiles

profiles.get
Read · Read a person’s profile as this team sees it
Exact grant required. 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 grant required. Underlying role scope: users:read.
profiles.draft
Write · Draft the empty parts of your own profile with Mello; nothing is saved
Exact grant required. Underlying role scope: profile:write.
profiles.employeeNumber
Write · Set a person’s employee number to an unused number
Exact grant required. 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 grant required. Underlying role scope: profile:write.
profiles.settings
Write · Choose who sees the optional parts of your own profile
Exact grant required. Underlying role scope: profile:write.

profiles.cover

profiles.cover.delete
Write · Remove your profile cover picture
Exact grant required. Underlying role scope: profile:write.

profiles.photo

profiles.photo.delete
Write · Remove your profile photo
Exact grant required. Underlying role scope: profile:write.

profiles.positions

profiles.positions.delete
Write · Remove a past position from your profile
Exact grant required. Underlying role scope: profile:write.
profiles.positions.save
Write · Add or change a past position on your profile
Exact grant required. Underlying role scope: profile:write.

programs

programs.get
Read · Read a program
Exact grant required. Underlying role scope: programs:read.
programs.list
Read · List programs
Exact grant required. Underlying role scope: programs:read.
programs.options
Read · List program setting choices
Exact grant required. Underlying role scope: programs:read.
programs.people
Read · List the people in a program and whether they take part
Exact grant required. Underlying role scope: programs:read.
programs.preview
Read · Preview matches without sending
Exact grant required. Underlying role scope: programs:read.
programs.schedulePreview
Read · Preview a program's upcoming rounds
Exact grant required. Underlying role scope: programs:read.
programs.archive
Write · Archive a program
Exact grant required. Underlying role scope: programs:write.
programs.create
Write · Create a program
Exact grant required. Underlying role scope: programs:write.
programs.joinChannel
Write · Add Shuffl to this public Slack channel
Exact grant required. Underlying role scope: programs:write.
programs.pause
Write · Pause a program
Exact grant required. Underlying role scope: programs:write.
programs.resume
Write · Activate a program and schedule
Exact grant required. Underlying role scope: programs:write.
programs.syncRoster
Write · Refresh channel membership
Exact grant required. Underlying role scope: programs:write.
programs.update
Write · Update a program
Exact grant required. 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 grant required. Underlying role scope: pulse:read.
pulse.asked
Read · List the Pulse questions asked so far
Exact grant required. Underlying role scope: self:read.
pulse.audienceOptions
Read · List the departments and teams a Pulse question can be aimed at
Exact grant required. Underlying role scope: pulse:read.
pulse.insights
Read · Read Pulse totals and trends (groups of seven or more)
Exact grant required. Underlying role scope: pulse:read.
pulse.latestRead
Read · Read what stands out in a closed Pulse question’s result
Exact grant required. Underlying role scope: pulse:read.
pulse.mine
Read · Read your own Pulse streak, how many took part, and what changed because of it
Exact grant required. Underlying role scope: self:read.
pulse.program
Read · Read the Pulse settings
Exact grant required. Underlying role scope: pulse:read.
pulse.proposals
Read · List the Pulse questions Mello suggested that wait for approval
Exact grant required. 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 grant required. Underlying role scope: pulse:read.
pulse.questions
Read · List the Pulse question library
Exact grant required. Underlying role scope: pulse:read.
pulse.today
Read · Read today’s Pulse question
Exact grant required. Underlying role scope: self:read.
pulse.addQuestion
Write · Add a Pulse question to the library
Exact grant required. Underlying role scope: pulse:write.
pulse.addTemplate
Write · Add a Pulse question set from a template
Exact grant required. Underlying role scope: pulse:write.
pulse.answer
Write · Answer today’s Pulse question as yourself
Exact grant required. Underlying role scope: self:write.
pulse.createAction
Write · Plan an action about a closed Pulse question, with an owner and a due date
Exact grant required. Underlying role scope: pulse:write.
pulse.decideProposal
Write · Approve a suggested Pulse question so it is asked next, or dismiss it
Exact grant required. Underlying role scope: pulse:write.
pulse.editProposal
Write · Reword a suggested Pulse question before approving it
Exact grant required. Underlying role scope: pulse:write.
pulse.proposeQuestions
Write · Save drafted Pulse questions as suggestions for HR to approve (never asked until approved)
Exact grant required. Underlying role scope: pulse:write.
pulse.requestProposals
Write · Ask Mello to suggest Pulse questions from recent results, optionally about a topic
Exact grant required. Underlying role scope: pulse:write.
pulse.saveProgram
Write · Save Pulse settings; enabling Pulse schedules questions to everyone
Exact grant required. Underlying role scope: pulse:write.
pulse.setQuestionAudience
Write · Aim a Pulse question at departments, teams, managers or ICs
Exact grant required. Underlying role scope: pulse:write.
pulse.setQuestionStatus
Write · Retire or restore a Pulse question
Exact grant required. Underlying role scope: pulse:write.
pulse.skip
Write · Skip today’s Pulse question
Exact grant required. Underlying role scope: self:write.
pulse.updateAction
Write · Change a Pulse action’s wording, owner, due date or status
Exact grant required. Underlying role scope: pulse:write.

reminders

reminders.mine
Read · Read your own Praise and Pulse reminder choices
Exact grant required. Underlying role scope: self:read.
reminders.settings
Read · Read whether Praise and Pulse reminders are on, and their timing
Exact grant required. Underlying role scope: team:read.
reminders.saveMine
Write · Change or turn off your own Praise or Pulse reminders
Exact grant required. Underlying role scope: self:write.
reminders.saveSetting
Write · Turn a Praise or Pulse reminder on or off, or change its timing
Exact grant required. Underlying role scope: team:write.

reports

reports.answerFeedback
Read · Read feedback on Mello's answers
Exact grant required. Underlying role scope: reports:read.
reports.connections
Read · Read Connections insights
Exact grant required. Underlying role scope: reports:read.
reports.knowledge
Read · Read Knowledge activity
Exact grant required. Underlying role scope: reports:read.
reports.knowledgeSource
Read · Read activity for one Knowledge source
Exact grant required. Underlying role scope: reports:read.
reports.melloTrial
Read · What Mello handled during the trial, from day 25 of a trial until it ends
Exact grant required. 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 grant required. Underlying role scope: reports:read.
reports.needsYou
Read · Read HR request and Knowledge draft insights
Exact grant required. Underlying role scope: reports:read.
reports.onboarding
Read · Read Onboarding insights
Exact grant required. Underlying role scope: reports:read.
reports.overview
Read · Read the workspace overview figures
Exact grant required. Underlying role scope: reports:read.
reports.people
Read · Read People insights: headcount, teams and growth
Exact grant required. Underlying role scope: reports:read.

runs

runs.details
Read · Read one introduction round and its pairs
Exact grant required. Underlying role scope: runs:read.
runs.get
Read · Read a run status
Exact grant required. Underlying role scope: runs:read.
runs.list
Read · List a program's introduction rounds
Exact grant required. Underlying role scope: runs:read.
runs.dispatch
Write · Dispatch this queued introduction run
Exact grant required. Underlying role scope: runs:write.
runs.request
Write · Request introductions from a preview
Exact grant required. Underlying role scope: runs:write.
runs.retry
Write · Retry introduction delivery
Exact grant required. Underlying role scope: runs:write.
runs.stopKnownFailures
Write · Stop retrying known failed deliveries and advance the preserved monthly schedule
Exact grant required. Underlying role scope: runs:write.

runs.history

runs.history.get
Read · Read one introduction round imported from the previous Shuffl
Exact grant required. Underlying role scope: exports:read.
runs.history.list
Read · List introduction rounds imported from the previous Shuffl
Exact grant required. Underlying role scope: exports:read.

support

support.get
Read · Read one Shuffl support conversation
Exact grant required. Underlying role scope: support:read.
support.list
Read · List the workspace's support conversations with Shuffl
Exact grant required. Underlying role scope: support:read.
support.assign
Write · Assign a Shuffl support conversation
Exact grant required. Underlying role scope: support:write.
support.close
Write · Close a Shuffl support conversation
Exact grant required. Underlying role scope: support:write.
support.create
Write · Start a support conversation with Shuffl
Exact grant required. Underlying role scope: support:write.
support.reply
Write · Reply in a Shuffl support conversation
Exact grant required. Underlying role scope: support:write.

sync

sync.current
Read · Read the People sync provider, its last sync and what it found
Exact grant required. Underlying role scope: integrations:read.
sync.connect
Write · Connect a directory sync provider with the credential given
Exact grant required. Underlying role scope: integrations:write.
sync.disconnect
Write · Disconnect this directory sync provider
Exact grant required. Underlying role scope: integrations:write.
sync.request
Write · Ask for a People sync provider Shuffl does not support yet
Exact grant required. Underlying role scope: integrations:write.
sync.run
Write · Sync People from the connected provider now
Exact grant required. Underlying role scope: integrations:write.

team

team.launchPost
Read · Read the launch announcement for the workspace
Exact grant required. Underlying role scope: team:read.
team.answerMinutes
Write · Set the team estimate of minutes per HR question, used for time saved
Exact grant required. Underlying role scope: team:write.
team.dismissLaunchPost
Write · Dismiss the Tell your team what they can ask post on Today for everyone
Exact grant required. Underlying role scope: team:write.

teams

teams.connectionPermissions
Read · List connections whose permissions are behind what Shuffl asks for
Exact grant required. 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 grant required. Underlying role scope: team:read.
teams.slackChannels
Read · List community channels in the connected Slack and what each would become
Exact grant required. Underlying role scope: integrations:read.
teams.slackJoinAccess
Read · Read whether Slack members can join Shuffl on their own
Exact grant required. Underlying role scope: team:read.
teams.slackProfileLink
Read · Read the Shuffl profile link setting for Slack profiles
Exact grant required. Underlying role scope: team:read.
teams.discardPairHistory
Write · Remove this staged past-intros report
Exact grant required. Underlying role scope: integrations:write.
teams.initialize
Write · Finish setting up a new workspace
Exact grant required. Underlying role scope: team:write.
teams.moveSlackChannels
Write · Set up each channel in Shuffl: paused intros, praise and celebrations
Exact grant required. Underlying role scope: integrations:write.
teams.rename
Write · Rename the workspace
Exact grant required. Underlying role scope: team:write.
teams.resendSlackWelcome
Write · Send the Slack install welcome to your own Slack DM again
Exact grant required. Underlying role scope: integrations:write.
teams.saveAgentSetup
Write · Choose the built-in assistant or an external agent for the workspace
Exact grant required. Underlying role scope: team:write.
teams.saveSlackJoinAccess
Write · Choose whether Slack members can join Shuffl on their own
Exact grant required. Underlying role scope: team:write.
teams.saveSlackProfileLink
Write · Turn the Shuffl profile link on Slack profiles on or off
Exact grant required. Underlying role scope: team:write.
teams.status
Write · Pause or resume the whole workspace
Exact grant required. Underlying role scope: team:write.
teams.syncSlackProfileLinks
Write · Write the Shuffl profile link to every Slack profile again
Exact grant required. Underlying role scope: team:write.
teams.uploadPairHistory
Write · Stage this past-intros report for the switch; nothing changes until it is applied
Exact grant required. Underlying role scope: integrations:write.

timeOff

timeOff.balances
Read · Read your own time-off balances from the connected HR system
Exact grant required. Underlying role scope: self:read.

units

units.list
Read · List the teams and departments in the People directory
Exact grant required. Underlying role scope: users:read.
units.archive
Write · Archive a team or department in the People directory
Exact grant required. Underlying role scope: users:write.
units.save
Write · Create or rename a team or department in the People directory
Exact grant required. Underlying role scope: users:write.

users

users.activity
Read · Read a person's recent activity in Shuffl
Exact grant required. Underlying role scope: users:read.
users.blockedPairs
Read · List pairs of people who are never introduced
Exact grant required. Underlying role scope: users:read.
users.details
Read · Read one person's People directory record
Exact grant required. Underlying role scope: users:read.
users.filterOptions
Read · List the teams, departments, managers and locations People can filter by
Exact grant required. Underlying role scope: users:read.
users.get
Read · Read a person
Exact grant required. Underlying role scope: users:read.
users.list
Read · List people
Exact grant required. Underlying role scope: users:read.
users.managerHistory
Read · Read a person's recorded manager history
Exact grant required. Underlying role scope: users:read.
users.managers
Read · List the managers in the People directory
Exact grant required. 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 grant required. Underlying role scope: users:read.
users.participants
Read · List the people who take part in programs
Exact grant required. Underlying role scope: users:read.
users.reportingLineProposal
Read · Read the reporting lines Mello proposed that wait for review
Exact grant required. Underlying role scope: users:read.
users.assignManagers
Write · Set the manager of several people at once
Exact grant required. Underlying role scope: users:write.
users.blockPair
Write · Stop two people from being introduced to each other
Exact grant required. Underlying role scope: users:write.
users.participation
Write · Opt a person in to or out of a program
Exact grant required. Underlying role scope: participation:write.
users.profile
Write · Edit a person's profile as an administrator
Exact grant required. Underlying role scope: profile:write.
users.proposeReportingLines
Write · Ask Mello to propose managers for people without one; nothing changes until reviewed
Exact grant required. Underlying role scope: users:write.
users.reviewReportingLines
Write · Approve chosen proposed reporting lines and close the proposal
Exact grant required. 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 grant required. Underlying role scope: users:write.