Skip to content
shuffl
Get started

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

Reference

Requests API

7 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.get

Read one request you asked for, approve or carry out, with its history

POST/api/v1/manage/requests/get

const result = await shuffl.requests.get({
  "requestId": "<requestId>"
});
Request fields (1)
  • requestId string required
Response object
  • 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
  • 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
  • filedBy null | object required
    • id string required
    • name string required
  • grantedThrough string[] required
  • id string required
  • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
  • kindLabel string 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
  • revision number required
  • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
  • statusLabel string required
  • title string required
  • waitingOn object[] required
    • id string required
    • name string required

requests.mine

List your own requests of every kind and where each stands

POST/api/v1/manage/requests/mine

const result = await shuffl.requests.mine({});
Request fields (1)
  • limit number optional
Response object[]
  • 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
  • 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
  • filedBy null | object required
    • id string required
    • name string required
  • grantedThrough string[] required
  • id string required
  • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
  • kindLabel string 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
  • revision number required
  • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
  • statusLabel string required
  • title string required
  • waitingOn object[] required
    • id string required
    • name string required

requests.waiting

List the requests waiting on you to decide or carry out

POST/api/v1/manage/requests/waiting

const result = await shuffl.requests.waiting();
Request fields (none)

This operation takes no input.

Response object
  • toComplete object[] 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
    • 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
    • filedBy null | object required
      • id string required
      • name string required
    • grantedThrough string[] required
    • id string required
    • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
    • kindLabel string 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
    • revision number required
    • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
    • statusLabel string required
    • title string required
    • waitingOn object[] required
      • id string required
      • name string required
  • toDecide object[] 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
    • 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
    • filedBy null | object required
      • id string required
      • name string required
    • grantedThrough string[] required
    • id string required
    • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
    • kindLabel string 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
    • revision number required
    • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
    • statusLabel string required
    • title string required
    • waitingOn object[] required
      • id string required
      • name string 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
    • 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
    • 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
    • filedBy null | object required
      • id string required
      • name string required
    • grantedThrough string[] required
    • id string required
    • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
    • kindLabel string 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
    • revision number required
    • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
    • statusLabel string required
    • title string required
    • waitingOn object[] required
      • id string required
      • name 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
    • 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
    • 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
    • filedBy null | object required
      • id string required
      • name string required
    • grantedThrough string[] required
    • id string required
    • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
    • kindLabel string 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
    • revision number required
    • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
    • statusLabel string required
    • title string required
    • waitingOn object[] required
      • id string required
      • name string 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
    • 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
    • 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
    • filedBy null | object required
      • id string required
      • name string required
    • grantedThrough string[] required
    • id string required
    • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
    • kindLabel string 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
    • revision number required
    • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
    • statusLabel string required
    • title string required
    • waitingOn object[] required
      • id string required
      • name string 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",
  "title": "<title>",
  "confirm": "requests.file"
});
Request fields (8)
  • approverPersonIds string[] 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 required
  • 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
    • 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
    • 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
    • filedBy null | object required
      • id string required
      • name string required
    • grantedThrough string[] required
    • id string required
    • kind "access" | "custom" | "equipment" | "finance" | "hr" | "letter" | "slack" required
    • kindLabel string 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
    • revision number required
    • status "approved" | "cancelled" | "declined" | "done" | "expired" | "failed" | "in_progress" | "pending_approval" | "revoked" required
    • statusLabel string required
    • title string required
    • waitingOn object[] required
      • id string required
      • name string required