Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

API keys API

3 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

credentials.api.list

List the workspace's API keys and what each can do

POST/api/v1/manage/credentials/api/list

const result = await shuffl.credentials.api.list();
Request fields (none)

This operation takes no input.

Response object
  • baseUrl string required
  • keys object[] required
    • expiresAt null | string (date-time) required
    • id string required
    • isActive boolean required
    • lastUsedAt null | string (date-time) required
    • name string required
    • permissions "access.enableSlack" | "access.get" | "access.save" | "access.saveRole" | "access.slackWaiting" | "actions.mine" | "assistant.conversations" | "assistant.delete" | "assistant.history" | "assistant.send" | "assistant.stop" | "badges.award" | "badges.claim" | "badges.decideRequest" | "badges.generatePicture" | "badges.hideOwn" | "badges.holders" | "badges.list" | "badges.ofPerson" | "badges.request" | "badges.revoke" | "badges.save" | "badges.saveSettings" | "badges.setHidden" | "badges.settings" | "badges.uploadPicture" | "capabilities.dismissRequests" | "capabilities.requestConnection" | "capabilities.requests" | "capabilities.sheet" | "capabilities.unlocks" | "celebrations.card" | "celebrations.cards" | "celebrations.deliveries" | "celebrations.mine" | "celebrations.preferences" | "celebrations.preview" | "celebrations.program" | "celebrations.refresh" | "celebrations.removeCardNote" | "celebrations.review" | "celebrations.save" | "celebrations.saveAnniversaryDate" | "celebrations.savePreferences" | "celebrations.signCard" | "celebrations.startDates" | "celebrations.thisWeek" | "channels.list" | "commands.get" | "communities.archive" | "communities.channelSuggestions" | "communities.createCapabilities" | "communities.createSlackChannel" | "communities.fromChannels" | "communities.generateCover" | "communities.invite" | "communities.join" | "communities.leave" | "communities.list" | "communities.members" | "communities.ofPerson" | "communities.removeMember" | "communities.revokeInvitation" | "communities.save" | "communities.setVisibility" | "communities.sync" | "communities.uploadCover" | "credentials.api.create" | "credentials.api.list" | "credentials.api.revoke" | "digest.actOnNudge" | "digest.culture" | "digest.dismissNudge" | "digest.nudge" | "digest.nudges" | "digest.preview" | "digest.saveSettings" | "digest.settings" | "exports.team" | "getStarted.celebrate" | "getStarted.celebration" | "getStarted.dismiss" | "getStarted.draftIntro" | "getStarted.get" | "getStarted.intro" | "getStarted.wizard" | "groups.allAutomations" | "groups.automationChoices" | "groups.automationInsights" | "groups.automationRuns" | "groups.automations" | "groups.directory" | "groups.directoryGroup" | "groups.discardMessage" | "groups.export" | "groups.get" | "groups.glance" | "groups.list" | "groups.members" | "groups.message" | "groups.messages" | "groups.options" | "groups.prepareMessage" | "groups.preview" | "groups.refresh" | "groups.remove" | "groups.removeAutomation" | "groups.save" | "groups.searchPeople" | "groups.sendMessage" | "groups.setAutomation" | "groups.setAutomationState" | "groups.setPlaybookAutoStart" | "groups.suggestions" | "home.feed" | "home.places" | "home.preferences" | "home.react" | "home.story" | "hr.categories" | "hr.command" | "hr.configure" | "hr.deliver" | "hr.get" | "hr.list" | "hr.mine" | "hr.readiness" | "hr.rebuildCategories" | "hr.renameTeam" | "hr.retryDelivery" | "hr.saveCategories" | "hr.settings" | "hr.share" | "hr.shareSources" | "identities.linkSlack" | "identities.linkWeb" | "identities.list" | "identities.slackAccounts" | "identities.unlink" | "identities.webAccounts" | "integrations.authorize" | "invitations.cancel" | "invitations.candidates" | "invitations.create" | "invitations.createMany" | "invitations.inviteDirectory" | "invitations.list" | "knowledge.acknowledgements.close" | "knowledge.acknowledgements.mine" | "knowledge.acknowledgements.remind" | "knowledge.acknowledgements.request" | "knowledge.acknowledgements.status" | "knowledge.connections.browse" | "knowledge.connections.connect" | "knowledge.connections.disconnect" | "knowledge.connections.list" | "knowledge.connections.request" | "knowledge.connections.requests" | "knowledge.context" | "knowledge.handbook.export" | "knowledge.policies.coverage" | "knowledge.search" | "knowledge.sources.archive" | "knowledge.sources.changeAudience" | "knowledge.sources.get" | "knowledge.sources.history" | "knowledge.sources.importConnected" | "knowledge.sources.importWebsite" | "knowledge.sources.list" | "knowledge.sources.publish" | "knowledge.sources.refresh" | "knowledge.sources.restore" | "knowledge.sources.save" | "knowledge.sources.search" | "knowledge.sources.withdraw" | "knowledge.sources.write" | "knowledge.templates.draft" | "knowledge.templates.facts" | "knowledge.uploads.appendPart" | "knowledge.uploads.complete" | "knowledge.uploads.create" | "knowledge.uploads.get" | "knowledge.uploads.retry" | "manager.current" | "mcp.knowledge" | "mentorship.checkIns.answer" | "mentorship.goals.remove" | "mentorship.goals.save" | "mentorship.join" | "mentorship.leave" | "mentorship.members.setStatus" | "mentorship.mentors.choose" | "mentorship.mine" | "mentorship.pairs.decide" | "mentorship.pairs.end" | "mentorship.pairs.setMine" | "mentorship.pairs.suggest" | "mentorship.programs.get" | "mentorship.programs.list" | "mentorship.programs.save" | "mentorship.programs.setStatus" | "mentorship.requests.answer" | "mentorship.sessions.remove" | "mentorship.sessions.save" | "mentorship.settings.get" | "mentorship.settings.save" | "network.claim" | "network.introductions" | "network.mine" | "network.ofPerson" | "network.orgChart" | "network.requestIntro" | "notifications.preferences" | "notifications.save" | "operations.activity" | "operations.dispatchInbox" | "operations.reconcile" | "operations.status" | "permissions.list" | "playbooks.answerBuddyAsk" | "playbooks.answerBuddyFollowUp" | "playbooks.answerCheckIn" | "playbooks.answerFirstDaysCheckIn" | "playbooks.answerForm" | "playbooks.approve" | "playbooks.askBuddy" | "playbooks.assignBuddy" | "playbooks.buddyCandidates" | "playbooks.buddyFollowUps" | "playbooks.buddyProgram" | "playbooks.buddySuggestions" | "playbooks.candidates" | "playbooks.completeTodo" | "playbooks.draftPlan" | "playbooks.enroll" | "playbooks.enrollmentPreview" | "playbooks.firstDaysCheckIns" | "playbooks.firstDaysResults" | "playbooks.mine" | "playbooks.nudge" | "playbooks.person" | "playbooks.plans" | "playbooks.previewAs" | "playbooks.previewEnrollment" | "playbooks.program" | "playbooks.remove" | "playbooks.respondBuddy" | "playbooks.retry" | "playbooks.run" | "playbooks.savePlan" | "playbooks.saveProgram" | "playbooks.setBuddyVolunteer" | "playbooks.setPlanGoal" | "playbooks.sharePlan" | "playbooks.update" | "playbooks.volunteerAsBuddy" | "praise.addChannel" | "praise.composer" | "praise.feed" | "praise.insights" | "praise.mine" | "praise.ofPerson" | "praise.removeChannel" | "praise.saveSettings" | "praise.send" | "praise.setDigest" | "praise.setHidden" | "praise.setRecognition" | "praise.settings" | "profiles.cover.delete" | "profiles.draft" | "profiles.employeeNumber" | "profiles.get" | "profiles.photo.delete" | "profiles.positions.delete" | "profiles.positions.save" | "profiles.save" | "profiles.settings" | "profiles.whoKnows" | "programs.archive" | "programs.communities" | "programs.create" | "programs.get" | "programs.joinChannel" | "programs.list" | "programs.options" | "programs.pause" | "programs.people" | "programs.preview" | "programs.resume" | "programs.schedulePreview" | "programs.syncRoster" | "programs.update" | "pulse.actions" | "pulse.addQuestion" | "pulse.addTemplate" | "pulse.answer" | "pulse.asked" | "pulse.createAction" | "pulse.decideProposal" | "pulse.editProposal" | "pulse.groupTrends" | "pulse.insights" | "pulse.latestRead" | "pulse.mine" | "pulse.program" | "pulse.proposals" | "pulse.proposeQuestions" | "pulse.questionDetail" | "pulse.questions" | "pulse.requestProposals" | "pulse.saveProgram" | "pulse.setQuestionGroup" | "pulse.setQuestionStatus" | "pulse.skip" | "pulse.today" | "pulse.updateAction" | "reminders.mine" | "reminders.saveMine" | "reminders.saveSetting" | "reminders.settings" | "reports.answerFeedback" | "reports.celebrations" | "reports.connections" | "reports.knowledge" | "reports.knowledgeSource" | "reports.melloTrial" | "reports.melloValue" | "reports.mentorship" | "reports.needsYou" | "reports.overview" | "reports.people" | "reports.playbooks" | "runs.details" | "runs.dispatch" | "runs.get" | "runs.history.get" | "runs.history.list" | "runs.list" | "runs.request" | "runs.retry" | "runs.stopKnownFailures" | "support.assign" | "support.close" | "support.create" | "support.get" | "support.list" | "support.reply" | "sync.connect" | "sync.current" | "sync.disconnect" | "sync.groups" | "sync.request" | "sync.run" | "sync.setGroup" | "sync.setWrites" | "team.answerMinutes" | "team.dismissLaunchPost" | "team.launchPost" | "teams.connectionPermissions" | "teams.current" | "teams.discardPairHistory" | "teams.initialize" | "teams.moveSlackChannels" | "teams.rename" | "teams.resendSlackWelcome" | "teams.saveAgentSetup" | "teams.saveSlackJoinAccess" | "teams.saveSlackProfileLink" | "teams.setup" | "teams.slackChannels" | "teams.slackConnection" | "teams.slackJoinAccess" | "teams.slackProfileLink" | "teams.status" | "teams.syncSlackProfileLinks" | "teams.uploadPairHistory" | "timeOff.balances" | "units.list" | "users.activity" | "users.assignManagers" | "users.blockPair" | "users.blockedPairs" | "users.details" | "users.filterOptions" | "users.get" | "users.glance" | "users.list" | "users.managerHistory" | "users.managers" | "users.page" | "users.participants" | "users.participation" | "users.profile" | "users.proposeReportingLines" | "users.reportingLineProposal" | "users.reviewReportingLines" | "users.save" | "webhooks.catalog" | "webhooks.create" | "webhooks.delete" | "webhooks.deliveries.get" | "webhooks.deliveries.list" | "webhooks.deliveries.replay" | "webhooks.deliveries.replayFailed" | "webhooks.get" | "webhooks.list" | "webhooks.rotateSecret" | "webhooks.sendTest" | "webhooks.update"[] required
    • scopes "access:read" | "access:write" | "assistant:read" | "assistant:write" | "celebrations:read" | "celebrations:write" | "credentials:read" | "credentials:write" | "exports:read" | "hr:read" | "hr:write" | "identities:read" | "identities:write" | "integrations:read" | "integrations:write" | "knowledge:manage" | "knowledge:read" | "knowledge:write" | "manager:read" | "mentorship:read" | "mentorship:write" | "operations:read" | "operations:write" | "operator:read" | "operator:write" | "participation:write" | "playbooks:read" | "playbooks:write" | "praise:read" | "praise:write" | "profile:write" | "programs:read" | "programs:write" | "pulse:read" | "pulse:write" | "reports:read" | "runs:read" | "runs:write" | "self:read" | "self:write" | "support:read" | "support:write" | "team:read" | "team:write" | "users:read" | "users:write" | "webhooks:read" | "webhooks:write"[] required
  • permissionCatalog object[] required
    • access "read" | "write" required
    • alwaysAllowed boolean required
    • description string required
    • grantable boolean required
    • granted boolean required
    • id "access.enableSlack" | "access.get" | "access.save" | "access.saveRole" | "access.slackWaiting" | "actions.mine" | "assistant.conversations" | "assistant.delete" | "assistant.history" | "assistant.send" | "assistant.stop" | "badges.award" | "badges.claim" | "badges.decideRequest" | "badges.generatePicture" | "badges.hideOwn" | "badges.holders" | "badges.list" | "badges.ofPerson" | "badges.request" | "badges.revoke" | "badges.save" | "badges.saveSettings" | "badges.setHidden" | "badges.settings" | "badges.uploadPicture" | "capabilities.dismissRequests" | "capabilities.requestConnection" | "capabilities.requests" | "capabilities.sheet" | "capabilities.unlocks" | "celebrations.card" | "celebrations.cards" | "celebrations.deliveries" | "celebrations.mine" | "celebrations.preferences" | "celebrations.preview" | "celebrations.program" | "celebrations.refresh" | "celebrations.removeCardNote" | "celebrations.review" | "celebrations.save" | "celebrations.saveAnniversaryDate" | "celebrations.savePreferences" | "celebrations.signCard" | "celebrations.startDates" | "celebrations.thisWeek" | "channels.list" | "commands.get" | "communities.archive" | "communities.channelSuggestions" | "communities.createCapabilities" | "communities.createSlackChannel" | "communities.fromChannels" | "communities.generateCover" | "communities.invite" | "communities.join" | "communities.leave" | "communities.list" | "communities.members" | "communities.ofPerson" | "communities.removeMember" | "communities.revokeInvitation" | "communities.save" | "communities.setVisibility" | "communities.sync" | "communities.uploadCover" | "credentials.api.create" | "credentials.api.list" | "credentials.api.revoke" | "digest.actOnNudge" | "digest.culture" | "digest.dismissNudge" | "digest.nudge" | "digest.nudges" | "digest.preview" | "digest.saveSettings" | "digest.settings" | "exports.team" | "getStarted.celebrate" | "getStarted.celebration" | "getStarted.dismiss" | "getStarted.draftIntro" | "getStarted.get" | "getStarted.intro" | "getStarted.wizard" | "groups.allAutomations" | "groups.automationChoices" | "groups.automationInsights" | "groups.automationRuns" | "groups.automations" | "groups.directory" | "groups.directoryGroup" | "groups.discardMessage" | "groups.export" | "groups.get" | "groups.glance" | "groups.list" | "groups.members" | "groups.message" | "groups.messages" | "groups.options" | "groups.prepareMessage" | "groups.preview" | "groups.refresh" | "groups.remove" | "groups.removeAutomation" | "groups.save" | "groups.searchPeople" | "groups.sendMessage" | "groups.setAutomation" | "groups.setAutomationState" | "groups.setPlaybookAutoStart" | "groups.suggestions" | "home.feed" | "home.places" | "home.preferences" | "home.react" | "home.story" | "hr.categories" | "hr.command" | "hr.configure" | "hr.deliver" | "hr.get" | "hr.list" | "hr.mine" | "hr.readiness" | "hr.rebuildCategories" | "hr.renameTeam" | "hr.retryDelivery" | "hr.saveCategories" | "hr.settings" | "hr.share" | "hr.shareSources" | "identities.linkSlack" | "identities.linkWeb" | "identities.list" | "identities.slackAccounts" | "identities.unlink" | "identities.webAccounts" | "integrations.authorize" | "invitations.cancel" | "invitations.candidates" | "invitations.create" | "invitations.createMany" | "invitations.inviteDirectory" | "invitations.list" | "knowledge.acknowledgements.close" | "knowledge.acknowledgements.mine" | "knowledge.acknowledgements.remind" | "knowledge.acknowledgements.request" | "knowledge.acknowledgements.status" | "knowledge.connections.browse" | "knowledge.connections.connect" | "knowledge.connections.disconnect" | "knowledge.connections.list" | "knowledge.connections.request" | "knowledge.connections.requests" | "knowledge.context" | "knowledge.handbook.export" | "knowledge.policies.coverage" | "knowledge.search" | "knowledge.sources.archive" | "knowledge.sources.changeAudience" | "knowledge.sources.get" | "knowledge.sources.history" | "knowledge.sources.importConnected" | "knowledge.sources.importWebsite" | "knowledge.sources.list" | "knowledge.sources.publish" | "knowledge.sources.refresh" | "knowledge.sources.restore" | "knowledge.sources.save" | "knowledge.sources.search" | "knowledge.sources.withdraw" | "knowledge.sources.write" | "knowledge.templates.draft" | "knowledge.templates.facts" | "knowledge.uploads.appendPart" | "knowledge.uploads.complete" | "knowledge.uploads.create" | "knowledge.uploads.get" | "knowledge.uploads.retry" | "manager.current" | "mcp.knowledge" | "mentorship.checkIns.answer" | "mentorship.goals.remove" | "mentorship.goals.save" | "mentorship.join" | "mentorship.leave" | "mentorship.members.setStatus" | "mentorship.mentors.choose" | "mentorship.mine" | "mentorship.pairs.decide" | "mentorship.pairs.end" | "mentorship.pairs.setMine" | "mentorship.pairs.suggest" | "mentorship.programs.get" | "mentorship.programs.list" | "mentorship.programs.save" | "mentorship.programs.setStatus" | "mentorship.requests.answer" | "mentorship.sessions.remove" | "mentorship.sessions.save" | "mentorship.settings.get" | "mentorship.settings.save" | "network.claim" | "network.introductions" | "network.mine" | "network.ofPerson" | "network.orgChart" | "network.requestIntro" | "notifications.preferences" | "notifications.save" | "operations.activity" | "operations.dispatchInbox" | "operations.reconcile" | "operations.status" | "permissions.list" | "playbooks.answerBuddyAsk" | "playbooks.answerBuddyFollowUp" | "playbooks.answerCheckIn" | "playbooks.answerFirstDaysCheckIn" | "playbooks.answerForm" | "playbooks.approve" | "playbooks.askBuddy" | "playbooks.assignBuddy" | "playbooks.buddyCandidates" | "playbooks.buddyFollowUps" | "playbooks.buddyProgram" | "playbooks.buddySuggestions" | "playbooks.candidates" | "playbooks.completeTodo" | "playbooks.draftPlan" | "playbooks.enroll" | "playbooks.enrollmentPreview" | "playbooks.firstDaysCheckIns" | "playbooks.firstDaysResults" | "playbooks.mine" | "playbooks.nudge" | "playbooks.person" | "playbooks.plans" | "playbooks.previewAs" | "playbooks.previewEnrollment" | "playbooks.program" | "playbooks.remove" | "playbooks.respondBuddy" | "playbooks.retry" | "playbooks.run" | "playbooks.savePlan" | "playbooks.saveProgram" | "playbooks.setBuddyVolunteer" | "playbooks.setPlanGoal" | "playbooks.sharePlan" | "playbooks.update" | "playbooks.volunteerAsBuddy" | "praise.addChannel" | "praise.composer" | "praise.feed" | "praise.insights" | "praise.mine" | "praise.ofPerson" | "praise.removeChannel" | "praise.saveSettings" | "praise.send" | "praise.setDigest" | "praise.setHidden" | "praise.setRecognition" | "praise.settings" | "profiles.cover.delete" | "profiles.draft" | "profiles.employeeNumber" | "profiles.get" | "profiles.photo.delete" | "profiles.positions.delete" | "profiles.positions.save" | "profiles.save" | "profiles.settings" | "profiles.whoKnows" | "programs.archive" | "programs.communities" | "programs.create" | "programs.get" | "programs.joinChannel" | "programs.list" | "programs.options" | "programs.pause" | "programs.people" | "programs.preview" | "programs.resume" | "programs.schedulePreview" | "programs.syncRoster" | "programs.update" | "pulse.actions" | "pulse.addQuestion" | "pulse.addTemplate" | "pulse.answer" | "pulse.asked" | "pulse.createAction" | "pulse.decideProposal" | "pulse.editProposal" | "pulse.groupTrends" | "pulse.insights" | "pulse.latestRead" | "pulse.mine" | "pulse.program" | "pulse.proposals" | "pulse.proposeQuestions" | "pulse.questionDetail" | "pulse.questions" | "pulse.requestProposals" | "pulse.saveProgram" | "pulse.setQuestionGroup" | "pulse.setQuestionStatus" | "pulse.skip" | "pulse.today" | "pulse.updateAction" | "reminders.mine" | "reminders.saveMine" | "reminders.saveSetting" | "reminders.settings" | "reports.answerFeedback" | "reports.celebrations" | "reports.connections" | "reports.knowledge" | "reports.knowledgeSource" | "reports.melloTrial" | "reports.melloValue" | "reports.mentorship" | "reports.needsYou" | "reports.overview" | "reports.people" | "reports.playbooks" | "runs.details" | "runs.dispatch" | "runs.get" | "runs.history.get" | "runs.history.list" | "runs.list" | "runs.request" | "runs.retry" | "runs.stopKnownFailures" | "support.assign" | "support.close" | "support.create" | "support.get" | "support.list" | "support.reply" | "sync.connect" | "sync.current" | "sync.disconnect" | "sync.groups" | "sync.request" | "sync.run" | "sync.setGroup" | "sync.setWrites" | "team.answerMinutes" | "team.dismissLaunchPost" | "team.launchPost" | "teams.connectionPermissions" | "teams.current" | "teams.discardPairHistory" | "teams.initialize" | "teams.moveSlackChannels" | "teams.rename" | "teams.resendSlackWelcome" | "teams.saveAgentSetup" | "teams.saveSlackJoinAccess" | "teams.saveSlackProfileLink" | "teams.setup" | "teams.slackChannels" | "teams.slackConnection" | "teams.slackJoinAccess" | "teams.slackProfileLink" | "teams.status" | "teams.syncSlackProfileLinks" | "teams.uploadPairHistory" | "timeOff.balances" | "units.list" | "users.activity" | "users.assignManagers" | "users.blockPair" | "users.blockedPairs" | "users.details" | "users.filterOptions" | "users.get" | "users.glance" | "users.list" | "users.managerHistory" | "users.managers" | "users.page" | "users.participants" | "users.participation" | "users.profile" | "users.proposeReportingLines" | "users.reportingLineProposal" | "users.reviewReportingLines" | "users.save" | "webhooks.catalog" | "webhooks.create" | "webhooks.delete" | "webhooks.deliveries.get" | "webhooks.deliveries.list" | "webhooks.deliveries.replay" | "webhooks.deliveries.replayFailed" | "webhooks.get" | "webhooks.list" | "webhooks.rotateSecret" | "webhooks.sendTest" | "webhooks.update" required
    • resource string required
    • scope null | "access:read" | "access:write" | "assistant:read" | "assistant:write" | "celebrations:read" | "celebrations:write" | "credentials:read" | "credentials:write" | "exports:read" | "hr:read" | "hr:write" | "identities:read" | "identities:write" | "integrations:read" | "integrations:write" | "knowledge:manage" | "knowledge:read" | "knowledge:write" | "manager:read" | "mentorship:read" | "mentorship:write" | "operations:read" | "operations:write" | "operator:read" | "operator:write" | "participation:write" | "playbooks:read" | "playbooks:write" | "praise:read" | "praise:write" | "profile:write" | "programs:read" | "programs:write" | "pulse:read" | "pulse:write" | "reports:read" | "runs:read" | "runs:write" | "self:read" | "self:write" | "support:read" | "support:write" | "team:read" | "team:write" | "users:read" | "users:write" | "webhooks:read" | "webhooks:write" required

credentials.api.create

Delegate a subset of this credential with bounded expiry and inherited revocation

POST/api/v1/manage/credentials/api/create

const result = await shuffl.credentials.api.create({
  "acknowledgeExternalAccess": true,
  "name": "<name>",
  "permissions": [
    "access.enableSlack"
  ],
  "confirm": "credentials.api.create",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • acknowledgeExternalAccess true required
  • name string required
  • permissions "access.enableSlack" | "access.get" | "access.save" | "access.saveRole" | "access.slackWaiting" | "actions.mine" | "assistant.conversations" | "assistant.delete" | "assistant.history" | "assistant.send" | "assistant.stop" | "badges.award" | "badges.claim" | "badges.decideRequest" | "badges.generatePicture" | "badges.hideOwn" | "badges.holders" | "badges.list" | "badges.ofPerson" | "badges.request" | "badges.revoke" | "badges.save" | "badges.saveSettings" | "badges.setHidden" | "badges.settings" | "badges.uploadPicture" | "capabilities.dismissRequests" | "capabilities.requestConnection" | "capabilities.requests" | "capabilities.sheet" | "capabilities.unlocks" | "celebrations.card" | "celebrations.cards" | "celebrations.deliveries" | "celebrations.mine" | "celebrations.preferences" | "celebrations.preview" | "celebrations.program" | "celebrations.refresh" | "celebrations.removeCardNote" | "celebrations.review" | "celebrations.save" | "celebrations.saveAnniversaryDate" | "celebrations.savePreferences" | "celebrations.signCard" | "celebrations.startDates" | "celebrations.thisWeek" | "channels.list" | "commands.get" | "communities.archive" | "communities.channelSuggestions" | "communities.createCapabilities" | "communities.createSlackChannel" | "communities.fromChannels" | "communities.generateCover" | "communities.invite" | "communities.join" | "communities.leave" | "communities.list" | "communities.members" | "communities.ofPerson" | "communities.removeMember" | "communities.revokeInvitation" | "communities.save" | "communities.setVisibility" | "communities.sync" | "communities.uploadCover" | "credentials.api.create" | "credentials.api.list" | "credentials.api.revoke" | "digest.actOnNudge" | "digest.culture" | "digest.dismissNudge" | "digest.nudge" | "digest.nudges" | "digest.preview" | "digest.saveSettings" | "digest.settings" | "exports.team" | "getStarted.celebrate" | "getStarted.celebration" | "getStarted.dismiss" | "getStarted.draftIntro" | "getStarted.get" | "getStarted.intro" | "getStarted.wizard" | "groups.allAutomations" | "groups.automationChoices" | "groups.automationInsights" | "groups.automationRuns" | "groups.automations" | "groups.directory" | "groups.directoryGroup" | "groups.discardMessage" | "groups.export" | "groups.get" | "groups.glance" | "groups.list" | "groups.members" | "groups.message" | "groups.messages" | "groups.options" | "groups.prepareMessage" | "groups.preview" | "groups.refresh" | "groups.remove" | "groups.removeAutomation" | "groups.save" | "groups.searchPeople" | "groups.sendMessage" | "groups.setAutomation" | "groups.setAutomationState" | "groups.setPlaybookAutoStart" | "groups.suggestions" | "home.feed" | "home.places" | "home.preferences" | "home.react" | "home.story" | "hr.categories" | "hr.command" | "hr.configure" | "hr.deliver" | "hr.get" | "hr.list" | "hr.mine" | "hr.readiness" | "hr.rebuildCategories" | "hr.renameTeam" | "hr.retryDelivery" | "hr.saveCategories" | "hr.settings" | "hr.share" | "hr.shareSources" | "identities.linkSlack" | "identities.linkWeb" | "identities.list" | "identities.slackAccounts" | "identities.unlink" | "identities.webAccounts" | "integrations.authorize" | "invitations.cancel" | "invitations.candidates" | "invitations.create" | "invitations.createMany" | "invitations.inviteDirectory" | "invitations.list" | "knowledge.acknowledgements.close" | "knowledge.acknowledgements.mine" | "knowledge.acknowledgements.remind" | "knowledge.acknowledgements.request" | "knowledge.acknowledgements.status" | "knowledge.connections.browse" | "knowledge.connections.connect" | "knowledge.connections.disconnect" | "knowledge.connections.list" | "knowledge.connections.request" | "knowledge.connections.requests" | "knowledge.context" | "knowledge.handbook.export" | "knowledge.policies.coverage" | "knowledge.search" | "knowledge.sources.archive" | "knowledge.sources.changeAudience" | "knowledge.sources.get" | "knowledge.sources.history" | "knowledge.sources.importConnected" | "knowledge.sources.importWebsite" | "knowledge.sources.list" | "knowledge.sources.publish" | "knowledge.sources.refresh" | "knowledge.sources.restore" | "knowledge.sources.save" | "knowledge.sources.search" | "knowledge.sources.withdraw" | "knowledge.sources.write" | "knowledge.templates.draft" | "knowledge.templates.facts" | "knowledge.uploads.appendPart" | "knowledge.uploads.complete" | "knowledge.uploads.create" | "knowledge.uploads.get" | "knowledge.uploads.retry" | "manager.current" | "mcp.knowledge" | "mentorship.checkIns.answer" | "mentorship.goals.remove" | "mentorship.goals.save" | "mentorship.join" | "mentorship.leave" | "mentorship.members.setStatus" | "mentorship.mentors.choose" | "mentorship.mine" | "mentorship.pairs.decide" | "mentorship.pairs.end" | "mentorship.pairs.setMine" | "mentorship.pairs.suggest" | "mentorship.programs.get" | "mentorship.programs.list" | "mentorship.programs.save" | "mentorship.programs.setStatus" | "mentorship.requests.answer" | "mentorship.sessions.remove" | "mentorship.sessions.save" | "mentorship.settings.get" | "mentorship.settings.save" | "network.claim" | "network.introductions" | "network.mine" | "network.ofPerson" | "network.orgChart" | "network.requestIntro" | "notifications.preferences" | "notifications.save" | "operations.activity" | "operations.dispatchInbox" | "operations.reconcile" | "operations.status" | "permissions.list" | "playbooks.answerBuddyAsk" | "playbooks.answerBuddyFollowUp" | "playbooks.answerCheckIn" | "playbooks.answerFirstDaysCheckIn" | "playbooks.answerForm" | "playbooks.approve" | "playbooks.askBuddy" | "playbooks.assignBuddy" | "playbooks.buddyCandidates" | "playbooks.buddyFollowUps" | "playbooks.buddyProgram" | "playbooks.buddySuggestions" | "playbooks.candidates" | "playbooks.completeTodo" | "playbooks.draftPlan" | "playbooks.enroll" | "playbooks.enrollmentPreview" | "playbooks.firstDaysCheckIns" | "playbooks.firstDaysResults" | "playbooks.mine" | "playbooks.nudge" | "playbooks.person" | "playbooks.plans" | "playbooks.previewAs" | "playbooks.previewEnrollment" | "playbooks.program" | "playbooks.remove" | "playbooks.respondBuddy" | "playbooks.retry" | "playbooks.run" | "playbooks.savePlan" | "playbooks.saveProgram" | "playbooks.setBuddyVolunteer" | "playbooks.setPlanGoal" | "playbooks.sharePlan" | "playbooks.update" | "playbooks.volunteerAsBuddy" | "praise.addChannel" | "praise.composer" | "praise.feed" | "praise.insights" | "praise.mine" | "praise.ofPerson" | "praise.removeChannel" | "praise.saveSettings" | "praise.send" | "praise.setDigest" | "praise.setHidden" | "praise.setRecognition" | "praise.settings" | "profiles.cover.delete" | "profiles.draft" | "profiles.employeeNumber" | "profiles.get" | "profiles.photo.delete" | "profiles.positions.delete" | "profiles.positions.save" | "profiles.save" | "profiles.settings" | "profiles.whoKnows" | "programs.archive" | "programs.communities" | "programs.create" | "programs.get" | "programs.joinChannel" | "programs.list" | "programs.options" | "programs.pause" | "programs.people" | "programs.preview" | "programs.resume" | "programs.schedulePreview" | "programs.syncRoster" | "programs.update" | "pulse.actions" | "pulse.addQuestion" | "pulse.addTemplate" | "pulse.answer" | "pulse.asked" | "pulse.createAction" | "pulse.decideProposal" | "pulse.editProposal" | "pulse.groupTrends" | "pulse.insights" | "pulse.latestRead" | "pulse.mine" | "pulse.program" | "pulse.proposals" | "pulse.proposeQuestions" | "pulse.questionDetail" | "pulse.questions" | "pulse.requestProposals" | "pulse.saveProgram" | "pulse.setQuestionGroup" | "pulse.setQuestionStatus" | "pulse.skip" | "pulse.today" | "pulse.updateAction" | "reminders.mine" | "reminders.saveMine" | "reminders.saveSetting" | "reminders.settings" | "reports.answerFeedback" | "reports.celebrations" | "reports.connections" | "reports.knowledge" | "reports.knowledgeSource" | "reports.melloTrial" | "reports.melloValue" | "reports.mentorship" | "reports.needsYou" | "reports.overview" | "reports.people" | "reports.playbooks" | "runs.details" | "runs.dispatch" | "runs.get" | "runs.history.get" | "runs.history.list" | "runs.list" | "runs.request" | "runs.retry" | "runs.stopKnownFailures" | "support.assign" | "support.close" | "support.create" | "support.get" | "support.list" | "support.reply" | "sync.connect" | "sync.current" | "sync.disconnect" | "sync.groups" | "sync.request" | "sync.run" | "sync.setGroup" | "sync.setWrites" | "team.answerMinutes" | "team.dismissLaunchPost" | "team.launchPost" | "teams.connectionPermissions" | "teams.current" | "teams.discardPairHistory" | "teams.initialize" | "teams.moveSlackChannels" | "teams.rename" | "teams.resendSlackWelcome" | "teams.saveAgentSetup" | "teams.saveSlackJoinAccess" | "teams.saveSlackProfileLink" | "teams.setup" | "teams.slackChannels" | "teams.slackConnection" | "teams.slackJoinAccess" | "teams.slackProfileLink" | "teams.status" | "teams.syncSlackProfileLinks" | "teams.uploadPairHistory" | "timeOff.balances" | "units.list" | "users.activity" | "users.assignManagers" | "users.blockPair" | "users.blockedPairs" | "users.details" | "users.filterOptions" | "users.get" | "users.glance" | "users.list" | "users.managerHistory" | "users.managers" | "users.page" | "users.participants" | "users.participation" | "users.profile" | "users.proposeReportingLines" | "users.reportingLineProposal" | "users.reviewReportingLines" | "users.save" | "webhooks.catalog" | "webhooks.create" | "webhooks.delete" | "webhooks.deliveries.get" | "webhooks.deliveries.list" | "webhooks.deliveries.replay" | "webhooks.deliveries.replayFailed" | "webhooks.get" | "webhooks.list" | "webhooks.rotateSecret" | "webhooks.sendTest" | "webhooks.update"[] required
  • confirm "credentials.api.create" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • baseUrl string required
    • expiresAt string (date-time) required
    • id string required
    • name string required
    • token string required

credentials.api.revoke

Revoke an API key

POST/api/v1/manage/credentials/api/revoke

const result = await shuffl.credentials.api.revoke({
  "id": "<id>",
  "requestKey": "a-new-unique-key"
});
Request fields (2)
  • id string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • revoked boolean required