Skip to content
shuffl
Get started

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

Reference

Exports API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

exports.team

Export the workspace's programs, people and introduction history

POST/api/v1/manage/exports/team

const result = await shuffl.exports.team();
Request fields (none)

This operation takes no input.

Response object
  • accessHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • billingMembers object[] required
    • assignedAt string (date-time) required
    • memberId string required
    • periodId string required
    • source "legacy" | "shuffl" required
    • teamId string required
  • billingPeriods object[] required
    • apiVersion null | string required
    • currency string required
    • customerId null | string required
    • end string (date-time) required
    • finalizedAt null | string (date-time) required
    • id string required
    • included number required
    • interval "annual" | "monthly" required
    • policyVersion string required
    • providerId null | string required
    • start string (date-time) required
    • subscriptionItemId null | string required
    • teamId string required
    • unitAmount number required
  • enrollments object[] required
    • breakUntil null | string (date-time) required
    • consentRevision number required
    • createdAt string (date-time) required
    • memberId string required
    • optedIn boolean required
    • present boolean required
    • programId string required
    • reason null | string required
    • teamId string required
    • updatedAt string (date-time) required
  • exportedAt string required
  • format string required
  • groupMembers object[] required
    • groupId string required
    • memberId string required
    • runId string required
    • teamId string required
  • groups object[] required
    • canceledAt null | string (date-time) required
    • channelId null | string required
    • deliveredAt null | string (date-time) required
    • id string required
    • ordinal number required
    • runId string required
    • teamId string required
  • legacyBillingHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • legacyEnrollmentHistory object[] optional
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • legacyMatchingHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • legacyMonthlyHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • legacyRunHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • legacySlackAssociationHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • managerHistory object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • pairs object[] required
    • blocked boolean required
    • memberA string required
    • memberB string required
    • teamId string required
    • weight number required
  • participants object[] required
    • active boolean required
    • bot boolean required
    • createdAt string (date-time) required
    • email null | string required
    • employeeNumber null | number required
    • id string required
    • name string required
    • profile object required
      • askMeAbout string[] optional
      • asks string optional
      • bio string optional
      • interests string optional
      • location string optional
      • offers string optional
      • phone string optional
      • preferredName string optional
      • pronouns string optional
      • role string optional
      • workingOn string optional
    • slackPhotoUrl null | string required
    • slackProfileLinkAt null | string (date-time) required
    • slackUserId null | string required
    • teamId string required
    • userId null | string required
  • peopleGroupMembers object[] required
    • department boolean required
    • enteredAt string (date-time) required
    • groupId string required
    • leftAt null | string (date-time) required
    • personId string required
    • teamId string required
  • peopleGroups object[] required
    • connectionId null | string required
    • createdAt string (date-time) required
    • createdBy null | string required
    • criteria object required
      • all object[] required
        • Option 1 object optional
          • attribute string required
          • operator string required
          • value string | number | false | true | string[] optional
        • Option 2 object optional
          • any object[] required
    • department boolean required
    • description string required
    • externalId null | string required
    • hrTeam boolean required
    • id string required
    • kind "dynamic" | "list" required
    • memberCount number required
    • name string required
    • onProfile boolean required
    • refreshError null | string required
    • refreshedAt null | string (date-time) required
    • source "directory" | "scim" | "shuffl" | "slack" required
    • suggestion null | string required
    • teamId string required
    • updatedAt string (date-time) required
  • personAccess object[] required
    • employment "employed" | "ended" | "on_leave" | "unknown" required
    • personId string required
    • provisioningActive null | false | true required
    • revision number required
    • status "enabled" | "pending" | "suspended" required
    • teamId string required
    • updatedAt string (date-time) required
  • personDirectory object[] required
    • employmentType null | "contractor" | "full_time" | "intern" | "part_time" | "temporary" required
    • jobTitle null | string required
    • lastDay null | string required
    • lastDayAnnounced boolean required
    • managedAt null | string (date-time) required
    • managedBy null | string required
    • managerId null | string required
    • memberId string required
    • originalStartDate null | string required
    • revision number required
    • startDate null | string required
    • teamId string required
    • timezone null | string required
    • updatedAt string (date-time) required
  • personIdentities object[] required
    • id string required
    • issuer string required
    • personId string required
    • provider string required
    • revision number required
    • revokedAt null | string (date-time) required
    • subject string required
    • teamId string required
    • verification string required
    • verifiedAt string (date-time) required
    • verifiedBy string required
  • programs object[] required
    • channelId string required
    • channelName string required
    • communityIds string[] required
    • createdAt string (date-time) required
    • groupId null | string required
    • id string required
    • includeBios boolean required
    • includeSchedulingLink boolean required
    • intro string required
    • kind "introductions" | "playbook" required
    • match object required
      • fineTune object optional
        • commonGround 0 | 1 | 2 required
        • meetRequests boolean required
        • mentionCommonGround boolean required
        • reach "any" | "far" | "fof" required
      • groupSize number required
      • iterations number required
      • keepApart object optional
        • relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
        • strict boolean required
      • maxGroupSize number required
      • strategy "cross-unit" | "group-frequency-weighted" | "group-frequency-weighted-v2" | "hosted" | "new-connections" | "random" | "unit-lottery-weighted" | "unit-weighted" | "unit-weighted-multiple-hosts-per-group" | "unit-weighted-one-host-per-group" | "within-unit" required
      • unitIds string[] optional
      • unitKind "community" | "department" | "team" optional
    • matchingReviewRequired boolean required
    • name string required
    • nextRunAt null | string (date-time) required
    • playbook null | object required
      • autoStart false | true optional
      • autoStartGroupId null | string optional
      • autoStartPaused false | true optional
      • buddy false | true optional
      • buddyFollowUpOffsetDays null | number optional
      • buddyInvitation string required
      • buddyOffsetDays number required
      • buddyTopics string[] optional
      • catchUp "bundle" | "shift" | "skip" optional
      • checkIn string required
      • checkInOffsetDays number required
      • dayZero "date" | "joined" | "last_day" | "start_date" optional
      • dayZeroDate null | string optional
      • helpCheckIn false | true optional
      • introductionOffsetDays number required
      • responderPersonId null | string required
      • sendTime string required
      • steps object[] optional
        • body string required
        • checkpoint "custom" | "day_30" | "day_365" | "day_60" | "day_90" optional
        • formFields "bio" | "birthday" | "photo" | "preferredName" | "pronouns"[] optional
        • id string required
        • kind "acknowledge" | "checkpoint" | "form" | "meet" | "message" | "task" required
        • meet "manager" | "person" | "skip_level" | "teammates" optional
        • meetCount number optional
        • notFor string[] optional
        • offsetDays number required
        • onlyFor string[] optional
        • personId null | string required
        • questions object[] optional
        • recipient "buddy" | "hire" | "hr" | "manager" | "person" required
        • resources object[] required
        • title string required
        • todos object[] required
      • timezone string required
    • revision number required
    • rosterSyncedAt null | string (date-time) required
    • schedule object required
      • Option 1 object optional
        • anchor string required
        • days number[] optional
        • frequency "days" | "hours" | "minutes" | "monthly-date" | "monthly-last-weekday" | "monthly-weekday" | "weeks" required
        • interval number required
        • timezone string required
      • Option 2 object optional
        • anchor string required
        • calendar object required
        • frequency "legacy-monthly" required
        • insufficientOptInsNotice object required
        • interval 1 required
        • origin "source-pending" optional
        • timezone string required
        • version 1 required
      • Option 3 object optional
        • anchor null | string required
        • calendar object required
        • frequency "legacy-monthly" required
        • insufficientOptInsNotice object required
        • interval 1 required
        • origin "operator-future-start" required
        • timezone string required
        • version 1 required
    • status "active" | "archived" | "paused" required
    • teamId string required
  • runMembers object[] required
    • consentRevision number required
    • memberId string required
    • runId string required
    • selected boolean required
    • teamId string required
  • runs object[] required
    • completedAt null | string (date-time) required
    • config object required
      • fineTune object optional
        • commonGround 0 | 1 | 2 required
        • meetRequests boolean required
        • mentionCommonGround boolean required
        • reach "any" | "far" | "fof" required
      • groupSize number required
      • iterations number required
      • keepApart object optional
        • relationships "department" | "know-each-other" | "reporting-line" | "team"[] required
        • strict boolean required
      • maxGroupSize number required
      • strategy string required
      • unitIds string[] optional
      • unitKind "community" | "department" | "team" optional
    • createdAt string (date-time) required
    • eligibleCount number required
    • historyFinalizedAt null | string (date-time) required
    • id string required
    • occurrence string (date-time) required
    • programId string required
    • reason null | string required
    • requestKey string required
    • revision number required
    • seed string required
    • selectedCount number required
    • status "canceled" | "completed" | "delivering" | "needs_review" | "partial" | "planned" | "queued" | "skipped" required
    • teamId string required
    • workflowId null | string required
  • team object required
    • id string required
    • name string required
    • policy object required
      • maxParticipants null | number required
      • maxPrograms null | number required
      • name "community" | "grandfathered" | "per-seat" | "pro" required
      • version string required
    • slackTeamId null | string required
    • status "active" | "archived" | "paused" | "uninstalled" required