Skip to content
shuffl
Get started

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

Reference

Hiring systems 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

hiring.hires

List the hires a hiring system sent, when each starts and what Shuffl wrote back

POST/api/v1/manage/hiring/hires

const result = await shuffl.hiring.hires();
Request fields (none)

This operation takes no input.

Response object
  • connections object[] required
    • canUpdateStartDates boolean required
    • id string required
    • label string required
    • notes boolean required
    • provider string required
    • providerName string required
  • hires object[] required
    • buddyName null | string required
    • connectionId string required
    • heldByHrSystem boolean required
    • id string required
    • jobTitle null | string required
    • met number required
    • name string required
    • offerStartDate null | string required
    • personId string required
    • playbook null | object required
      • name string required
      • status "active" | "completed" | "removed" required
    • providerName string required
    • startDate null | string required
    • startDateDiffers boolean required
    • status "accepted" | "hired" | "withdrawn" required
    • updatedAt string required
    • vendorUrl null | string required
    • written "buddy_assigned" | "day_one" | "playbook_started"[] required

hiring.setNotes

Turn recruiter notes and tags in a hiring system on or off

POST/api/v1/manage/hiring/setNotes

  • Write
  • Permission hiring.setNotes
  • Needs a requestKey
  • Needs confirm set to hiring.setNotes
const result = await shuffl.hiring.setNotes({
  "connectionId": "<connectionId>",
  "enabled": false,
  "confirm": "hiring.setNotes",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • connectionId string required
  • enabled boolean required
  • confirm "hiring.setNotes" 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
    • connectionId string required
    • notes boolean required

hiring.updateStartDate

Change a hire’s offer start date in the hiring system

POST/api/v1/manage/hiring/updateStartDate

const result = await shuffl.hiring.updateStartDate({
  "hireId": "<hireId>",
  "requestKey": "a-new-unique-key",
  "startDate": "<startDate>",
  "confirm": "hiring.updateStartDate"
});
Request fields (4)
  • hireId string required
  • requestKey string required1 to 128 characters
  • startDate string required
  • confirm "hiring.updateStartDate" 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 object required
      • cancellable boolean required
      • createdAt string required
      • details object required
        • Option 1 object optional
          • appName string required
          • groups object[] required
          • kind "access" required
          • levelName null | string required
          • operation "add" | "remove" required
          • requestId string required
        • Option 2 object optional
          • event null | "buddy_assigned" | "day_one" | "playbook_started" required
          • hireId string required
          • kind "hiring" required
          • startDate null | string required
          • text string required
          • write "note" | "start_date" | "tag" required
        • Option 3 object optional
          • caseId string required
          • categoryId null | string required
          • destinationId string required
          • destinationLabel string required
          • kind "ticket" required
          • ticketKey null | string required
        • Option 4 object optional
          • amount null | number required
          • approver null | string required
          • endDate string required
          • endHalfDay boolean required
          • kind "time_off" required
          • policy string required
          • policyId null | string required
          • startDate string required
          • startHalfDay boolean required
          • unit null | "days" | "hours" required
      • errorCode null | string required
      • id string required
      • kind "access" | "hiring" | "ticket" | "time_off" required
      • lastCheckedAt null | string required
      • provider string required
      • providerName string required
      • settledAt null | string required
      • status "approved" | "cancelled" | "declined" | "failed" | "prepared" | "resolved" | "running" | "submitted" | "unknown" required
      • statusLabel string required
      • submittedAt null | string required
      • vendorUrl null | string required
    • providerName string required
    • startDate string required
    • status "approved" | "cancelled" | "declined" | "failed" | "prepared" | "resolved" | "running" | "submitted" | "unknown" required
    • summary string required