TurnShift shift scheduling API

{
  "users": [
    {
      "id": 1,
      "email": "john@example.com",
      "name": "John Doe",
      "timezone": "America/New_York",
      "role": "manager",
      "teams": [{ "id": 1, "name": "Support" }]
    }
  ]
}

{
  "organization": {
    "id": 123,
    "name": "Acme Inc",
    "slug": "acme-inc",
    "language": "en",
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
}

{
  "name": "Morning Support",
  "startTime": "09:00",
  "endTime": "17:00",
  "timeZone": "Europe/Paris",
  "slackChannelName": "#support",  // or "slackChannelId": 123
  "microsoftChannel": "Support crew › General",  // optional, or its id
  "numberOfShiftsToBookPerDay": { "1": 1, "2": 1, "3": 1, "4": 1, "5": 1, "6": 0, "7": 0 },
  "startMessageNote": "Remember to check the runbook.",
  "users": ["john@example.com", "jane@example.com"],  // optional
  "teamIds": [3],                                     // optional
  "rotation": {                                       // optional
    "turnUnit": "week",  // or "day"
    "turnLength": 1,     // 1 to 8
    "startsOn": "2024-01-15"
  }
}

{
  "shift": { "id": 1, "name": "Morning Support", "active": true, ... },
  "teamId": 7,      // the new team, null without users
  "rotationId": 4   // null for manual assignments
}

{
  "name": "Evening Support"  // "<name> (copy)" by default
}

{
  "shift": { "id": 2, "name": "Morning Support (copy)", "active": false, ... },
  "teamIds": [3, 7]
}

{
  "shiftIds": [2, 3, 4],
  "active": true  // false turns them off
}

{
  "shifts": [{ "id": 2, "name": "Morning Support", "active": true }, ...],
  "changedIds": [2, 4]
}

{
  "id": 1,
  "name": "Morning Support",
  "startTime": "09:00",
  "endTime": "17:00",
  "timeZone": "Europe/Paris",
  "slackChannelId": 123,
  "startMessageNote": null
}

{
  "slackChannelName": "#support-oncall",  // or "slackChannelId": 124
  "microsoftChannel": "Support crew › On-call",  // or its id, null for none
  "startMessageNote": "Remember to check the runbook.",
  "numberOfShiftsToBookPerDay": { "1": 1, "2": 1, "3": 1, "4": 1, "5": 1, "6": 0, "7": 0 },
  "channelMessagesOnChangeOnly": true,
  "sendOpenSeatsWarning": true,
  "freeForm": false
}

{
  "shift": { "id": 1, "name": "Support" },
  "year": 2024,
  "month": 1,
  "bookings": {
    "2024-01-15": [
      { "id": 1, "email": "john@example.com", "name": "John Doe" }
    ],
    "2024-01-16": []
  }
}

{
  "user": "john@example.com"  // or user ID: "123"
}

{
  "user": "john@example.com",
  "startDate": "2024-01-15",
  "endDate": "2024-01-26",
  "weekdays": [1, 2, 3, 4, 5]
}

{
  "assigned": ["2024-01-15", "2024-01-16"],
  "skipped": [
    { "date": "2024-01-17", "reason": "already_booked" }
  ]
}

{
  "user": "john@example.com",
  "startDate": "2024-01-15",
  "endDate": "2024-01-26",
  "weekdays": [1, 2, 3, 4, 5]
}

{ "unassigned": ["2024-01-15", "2024-01-16"] }

{
  "startDate": "2024-01-15",
  "endDate": "2024-01-26"
}

{
  "assigned": [
    {
      "date": "2024-01-15",
      "user": { "id": 1, "email": "john@example.com", "name": "John Doe" }
    }
  ]
}

{
  "user": "john@example.com"
}

{
  "users": ["john@example.com", "jane@example.com"],
  "turnUnit": "week",   // or "day"
  "turnLength": 1,      // 1 to 8
  "peoplePerTurn": 1,   // optional
  "startsOn": "2024-01-15"
}

{
  "users": ["jane@example.com", "john@example.com", "ana@example.com"],
  "turnUnit": "week",
  "turnLength": 1,
  "startSooner": false,  // true: people added take the next turn
  "covers": [            // who takes the open turns of people removed
    { "user": "jane@example.com", "dates": ["2024-01-22", "2024-01-23"] }
  ],
  "dryRun": true
}

{
  "at": "2024-01-15T09:00:00.000Z",
  "schedules": [
    {
      "schedule": { "id": 1, "name": "Support", "startTime": "09:00",
        "endTime": "18:00", "timeZone": "Europe/Paris" },
      "date": "2024-01-15",
      "people": [{ "email": "john@example.com", "name": "John Doe" }]
    }
  ]
}

{
  "from": "2024-01-01",
  "to": "2024-01-31",
  "scheduleId": 1,
  "schedules": [{ "id": 1, "name": "Support", "timeZone": "Europe/Paris" }],
  "people": [
    {
      "id": 2, "name": "John Doe", "email": "john@example.com",
      "leftSlack": false, "shifts": 8, "days": 8, "hours": 72,
      "weekdayHours": 54, "weekendHours": 18, "nightHours": 0,
      "schedules": [{ "id": 1, "shifts": 8, "days": 8, "hours": 72,
        "weekdayHours": 54, "weekendHours": 18, "nightHours": 0 }]
    }
  ],
  "totals": { "shifts": 8, "hours": 72, "weekdayHours": 54,
    "weekendHours": 18, "nightHours": 0 }
}

{ "name": "Support Team" }

{ "user": "john@example.com" }

{ "user": "john@example.com" }

{
  "links": [
    {
      "id": 12,
      "token": "your-link-token",
      "url": "https://turnshift.app/view/your-link-token",
      "scheduleIds": [1],
      "password": false,
      "createdAt": "2026-10-26T09:00:00.000Z"
    }
  ]
}

{ "scheduleIds": [1], "password": "tea time" }

{
  "invoices": [
    {
      "number": "TS-0042",
      "date": "2024-01-01",
      "total": "35.00",
      "currency": "EUR",
      "status": "paid",
      "url": "https://invoice.stripe.com/...",
      "pdf": "https://pay.stripe.com/invoice/.../pdf"
    }
  ]
}

{
  "entries": [
    {
      "title": "Roles are here",
      "date": "2026-08-29T22:52:35Z",
      "url": "https://turnshift.app/blog/roles-are-here",
      "summary": "Until now anyone in your organization could edit anything...",
      "markdown": "Until now anyone in your organization could edit anything..."
    }
  ]
}