Skip to main content
GET
/
schedule
/
v1
/
planners
/
{plannerId}
/
shift-assignments
List Shift Assignments in Planner
curl --request GET \
  --url https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-{region}.sesametime.com/schedule/v1/planners/{plannerId}/shift-assignments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shiftId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shiftName": "<string>",
      "date": "2026-02-10",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "comments": "<string>",
      "ranges": [
        {
          "from": "09:00",
          "to": "14:00"
        }
      ]
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plannerId
string<uuid>
required

The planner ID

Query Parameters

from
string<date>

Filter by date greater than or equal (Y-m-d)

Example:

"2026-02-01"

to
string<date>

Filter by date less than or equal (Y-m-d)

Example:

"2026-02-28"

employeeId[in]
string

Filter by employee IDs (comma-separated UUIDs)

type
enum<string>

Filter by assignment type. Omit to return both.

Available options:
shift,
freeDay
page
integer
default:1

Request a specific page

limit
integer
default:20

Items per page

Response

200 - application/json

Array of Objects

data
object[]
meta
object