Reference
Requests API
15 operations. Generated from the OpenAPI document, so this page always matches the API.
OpenAPI documentErrors and rate limitsSDK and CLI recipes
On this page
requests.channels
List the Slack channels that take requests, each with its mode and what came in during the last 30 days
POST/api/v1/manage/requests/channels
- Read
- Permission requests.channels
const result = await shuffl.requests.channels();Request fields (none)
This operation takes no input.
Response object[]
- channelId string required
- channelName string required
- createdAt string required
- isPrivate boolean required
- last30Days object required
- answered number required
- filed number required
- mode "always" | "silent" | "when_asked" required
- modeLabel string required
requests.get
Read one request you asked for, approve or carry out, with its history
POST/api/v1/manage/requests/get
- Read
- Permission requests.get
const result = await shuffl.requests.get({
"requestId": "<requestId>"
});Request fields (1)
- requestId string required
Response object
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- events object[] required
- action string required
- actor null | object required
- id string required
- name string required
- at string required
- body null | string required
- id string required
- label string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
requests.letterTemplate
Read the letter template: company, address, signatory and whether salary may be asked for
POST/api/v1/manage/requests/letterTemplate
- Read
- Permission requests.letterTemplate
const result = await shuffl.requests.letterTemplate();Request fields (none)
This operation takes no input.
Response object
- address string required
- clause string required
- companyName string required
- revision number required
- salaryWithApproval boolean required
- saved boolean required
- signatory null | object required
- id string required
- name string required
- updatedAt null | string required
requests.mine
List your own requests of every kind and where each stands
POST/api/v1/manage/requests/mine
- Read
- Permission requests.mine
const result = await shuffl.requests.mine({});Request fields (1)
- limit number optional
Response object[]
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
requests.types
List the kinds of request people can make here and what each asks for
POST/api/v1/manage/requests/types
- Read
- Permission requests.types
const result = await shuffl.requests.types({});Request fields (1)
- includeArchived false | true optional
Response object
- admin boolean required
- types object[] required
- action null | object required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- missingScopes string[] required
- slackConnected boolean required
- slackLive boolean required
- target null | object required
- id string required
- name string required
- approvalNeeded boolean required
- approvers object[] required
- Option 1 object optional
- kind "manager" required
- Option 2 object optional
- kind "owners" required
- Option 3 object optional
- kind "person" required
- personIds string[] required
- Option 4 object optional
- groupIds string[] required
- kind "group" required
- quorum "all" | "one" required
- Option 1 object optional
- approverWords string required
- archived boolean required
- description string required
- fields object[] required
- id string required
- label string required
- options string[] optional
- required boolean required
- type "choice" | "date" | "long_text" | "money" | "person" | "short_text" required
- handoff null | object required
- operation "accessRequests.request" | "timeOff.request" required
- when string required
- id string required
- keywords string[] required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
- kindLabel string required
- name string required
- onApproval "assign_task_to_owner" | "none" required
- owners object[] required
- id string required
- name string required
- responseDays number required
- revision number required
- sensitive boolean required
- starter boolean required
- starterKey null | string required
- updatedAt string required
- action null | object required
requests.waiting
List the requests waiting on you to decide or carry out
POST/api/v1/manage/requests/waiting
- Read
- Permission requests.waiting
const result = await shuffl.requests.waiting();Request fields (none)
This operation takes no input.
Response object
- toComplete object[] required
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
- action null | object required
- toDecide object[] required
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
- action null | object required
requests.answer
Answer an approver’s question on your request
POST/api/v1/manage/requests/answer
- Write
- Permission requests.answer
- Needs a requestKey
- Needs confirm set to requests.answer
const result = await shuffl.requests.answer({
"answer": "<answer>",
"requestId": "<requestId>",
"confirm": "requests.answer",
"requestKey": "a-new-unique-key"
});Request fields (4)
- answer string required
- requestId string required
- confirm "requests.answer" 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
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- events object[] required
- action string required
- actor null | object required
- id string required
- name string required
- at string required
- body null | string required
- id string required
- label string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
- action null | object required
requests.archiveType
Take a request type out of the catalog, or put it back
POST/api/v1/manage/requests/archiveType
- Write
- Permission requests.archiveType
- Needs a requestKey
- Needs confirm set to requests.archiveType
const result = await shuffl.requests.archiveType({
"typeId": "<typeId>",
"confirm": "requests.archiveType",
"requestKey": "a-new-unique-key"
});Request fields (4)
- archived false | true optional
- typeId string required
- confirm "requests.archiveType" 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
- action null | object required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- missingScopes string[] required
- slackConnected boolean required
- slackLive boolean required
- target null | object required
- id string required
- name string required
- approvalNeeded boolean required
- approvers object[] required
- Option 1 object optional
- kind "manager" required
- Option 2 object optional
- kind "owners" required
- Option 3 object optional
- kind "person" required
- personIds string[] required
- Option 4 object optional
- groupIds string[] required
- kind "group" required
- quorum "all" | "one" required
- Option 1 object optional
- approverWords string required
- archived boolean required
- description string required
- fields object[] required
- id string required
- label string required
- options string[] optional
- required boolean required
- type "choice" | "date" | "long_text" | "money" | "person" | "short_text" required
- handoff null | object required
- operation "accessRequests.request" | "timeOff.request" required
- when string required
- id string required
- keywords string[] required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
- kindLabel string required
- name string required
- onApproval "assign_task_to_owner" | "none" required
- owners object[] required
- id string required
- name string required
- responseDays number required
- revision number required
- sensitive boolean required
- starter boolean required
- starterKey null | string required
- updatedAt string required
- action null | object required
requests.bindChannel
Take requests in a Slack channel Shuffl is in, or change how it listens: always, when asked or silent
POST/api/v1/manage/requests/bindChannel
- Write
- Permission requests.bindChannel
- Needs a requestKey
- Needs confirm set to requests.bindChannel
const result = await shuffl.requests.bindChannel({
"channelId": "<channelId>",
"confirm": "requests.bindChannel",
"requestKey": "a-new-unique-key"
});Request fields (4)
- channelId string required
- mode "always" | "silent" | "when_asked" optional
- confirm "requests.bindChannel" 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
- channelId string required
- channelName string required
- createdAt string required
- isPrivate boolean required
- last30Days object required
- answered number required
- filed number required
- mode "always" | "silent" | "when_asked" required
- modeLabel string required
requests.cancel
Cancel a request you made while it waits or before it is carried out
POST/api/v1/manage/requests/cancel
- Write
- Permission requests.cancel
- Needs a requestKey
- Needs confirm set to requests.cancel
const result = await shuffl.requests.cancel({
"requestId": "<requestId>",
"confirm": "requests.cancel",
"requestKey": "a-new-unique-key"
});Request fields (4)
- note string optional
- requestId string required
- confirm "requests.cancel" 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
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- events object[] required
- action string required
- actor null | object required
- id string required
- name string required
- at string required
- body null | string required
- id string required
- label string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
- action null | object required
requests.complete
Mark an approved request you carry out as done, so the person is told
POST/api/v1/manage/requests/complete
- Write
- Permission requests.complete
- Needs a requestKey
- Needs confirm set to requests.complete
const result = await shuffl.requests.complete({
"requestId": "<requestId>",
"confirm": "requests.complete",
"requestKey": "a-new-unique-key"
});Request fields (4)
- note string optional
- requestId string required
- confirm "requests.complete" 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
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- events object[] required
- action string required
- actor null | object required
- id string required
- name string required
- at string required
- body null | string required
- id string required
- label string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
- action null | object required
requests.file
Ask for something that needs approval: what you need, why, and who should approve it
POST/api/v1/manage/requests/file
- Write
- Permission requests.file
- Needs a requestKey
- Needs confirm set to requests.file
const result = await shuffl.requests.file({
"requestKey": "a-new-unique-key",
"confirm": "requests.file"
});Request fields (10)
- approverPersonIds string[] optional
- fields object optional
- forPersonId string optional
- kind "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" optional
- note string optional
- ownerPersonIds string[] optional
- requestKey string required1 to 128 characters
- title string optional
- typeId string optional
- confirm "requests.file" required
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
- action null | object required
- attempts number required
- error null | string required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- plan string required
- receipt null | object required
- channelName null | string required
- revoked boolean required
- reversible boolean required
- app null | object required
- id string required
- logoUrl null | string required
- name string required
- approvals object[] required
- decidedAt null | string required
- decision null | "approved" | "declined" | "replaced" required
- kind "admin" | "group" | "manager" | "person" | "resource_owner" required
- note null | string required
- person object required
- id string required
- name string required
- quorum "all" | "one" required
- step number required
- canAnswer boolean required
- canCancel boolean required
- canComplete boolean required
- canDecide boolean required
- canRetry boolean required
- canRevoke boolean required
- completedAt null | string required
- createdAt string required
- decidedAt null | string required
- decidedBy null | object required
- id string required
- name string required
- decisionNote null | string required
- duplicate boolean required
- events object[] required
- action string required
- actor null | object required
- id string required
- name string required
- at string required
- body null | string required
- id string required
- label string required
- expiresAt string required
- fields object[] required
- field string required
- label string required
- value string required
- filedBy null | object required
- id string required
- name string required
- forYou boolean required
- grantedThrough string[] required
- id string required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" | "time_off" required
- kindLabel string required
- letter null | object required
- downloadUrl null | string required
- missing string[] required
- salary boolean required
- note string required
- outcome null | string required
- owners object[] required
- id string required
- name string required
- person object required
- id string required
- name string required
- question null | object required
- at string required
- by null | object required
- id string required
- name string required
- text string required
- respondBy null | string required
- revision number required
- sensitive boolean required
- status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
- statusLabel string required
- timeOff null | object required
- decidesIn "shuffl" | "vendor" required
- providerName string required
- vendorUrl null | string required
- title string required
- type null | object required
- id string required
- name string required
- waitingOn object[] required
- id string required
- name string required
- waitsOnYou boolean required
- action null | object required
requests.saveLetterTemplate
Change the letter template: company, address, who signs, an extra paragraph and salary letters
POST/api/v1/manage/requests/saveLetterTemplate
- Write
- Permission requests.saveLetterTemplate
- Needs a requestKey
- Needs confirm set to requests.saveLetterTemplate
const result = await shuffl.requests.saveLetterTemplate({
"confirm": "requests.saveLetterTemplate",
"requestKey": "a-new-unique-key"
});Request fields (8)
- address string optional
- clause string optional
- companyName string optional
- expectedRevision number optional
- salaryWithApproval false | true optional
- signatoryPersonId null | string optional
- confirm "requests.saveLetterTemplate" 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
- address string required
- clause string required
- companyName string required
- revision number required
- salaryWithApproval boolean required
- saved boolean required
- signatory null | object required
- id string required
- name string required
- updatedAt null | string required
requests.saveType
Add or change a request type: its fields, approvers, owners and response target
POST/api/v1/manage/requests/saveType
- Write
- Permission requests.saveType
- Needs a requestKey
- Needs confirm set to requests.saveType
const result = await shuffl.requests.saveType({
"name": "<name>",
"confirm": "requests.saveType",
"requestKey": "a-new-unique-key"
});Request fields (18)
- action null | "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" optional
- actionTarget null | object optional
- id string required
- name string required
- approvalNeeded false | true optional
- approvers object[] optional
- Option 1 object optional
- kind "manager" required
- Option 2 object optional
- kind "owners" required
- Option 3 object optional
- kind "person" required
- personIds string[] required
- Option 4 object optional
- groupIds string[] required
- kind "group" required
- quorum "all" | "one" optional
- Option 1 object optional
- authoredBy "form" | "text" optional
- description string optional
- expectedRevision number optional
- fields object[] optional
- id string required
- label string required
- options string[] optional
- required false | true optional
- type "choice" | "date" | "long_text" | "money" | "person" | "short_text" required
- keywords string[] optional
- kind "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" optional
- name string required
- onApproval "assign_task_to_owner" | "none" optional
- ownerPersonIds string[] optional
- responseDays number optional
- sensitive false | true optional
- typeId string optional
- confirm "requests.saveType" 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
- action null | object required
- kind "slack_channel_create" | "slack_channel_invite" | "slack_guest_invite" | "slack_usergroup_add" required
- label string required
- missingScopes string[] required
- slackConnected boolean required
- slackLive boolean required
- target null | object required
- id string required
- name string required
- approvalNeeded boolean required
- approvers object[] required
- Option 1 object optional
- kind "manager" required
- Option 2 object optional
- kind "owners" required
- Option 3 object optional
- kind "person" required
- personIds string[] required
- Option 4 object optional
- groupIds string[] required
- kind "group" required
- quorum "all" | "one" required
- Option 1 object optional
- approverWords string required
- archived boolean required
- description string required
- fields object[] required
- id string required
- label string required
- options string[] optional
- required boolean required
- type "choice" | "date" | "long_text" | "money" | "person" | "short_text" required
- handoff null | object required
- operation "accessRequests.request" | "timeOff.request" required
- when string required
- id string required
- keywords string[] required
- kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
- kindLabel string required
- name string required
- onApproval "assign_task_to_owner" | "none" required
- owners object[] required
- id string required
- name string required
- responseDays number required
- revision number required
- sensitive boolean required
- starter boolean required
- starterKey null | string required
- updatedAt string required
- action null | object required
requests.unbindChannel
Stop taking requests in a Slack channel; requests already filed stay
POST/api/v1/manage/requests/unbindChannel
- Write
- Permission requests.unbindChannel
- Needs a requestKey
- Needs confirm set to requests.unbindChannel
const result = await shuffl.requests.unbindChannel({
"channelId": "<channelId>",
"confirm": "requests.unbindChannel",
"requestKey": "a-new-unique-key"
});Request fields (3)
- channelId string required
- confirm "requests.unbindChannel" 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
- removed boolean required