Skip to main content
POST
/
api
/
schedule
/
schedule-templates.list
List schedule templates
curl --request POST \
  --url https://api.example.com/api/schedule/schedule-templates.list \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "872815618512410358"
  ],
  "teams": [
    "872815618512410358"
  ],
  "date_range": "2019-11-11/2019-12-12",
  "is_on_call": true
}
'
[
  {
    "id": "872815618512410358",
    "name": {
      "en": "Hello",
      "fr": "Bonjour",
      "de": "Guten Tag"
    },
    "description": {
      "en": "Hello",
      "fr": "Bonjour",
      "de": "Guten Tag"
    },
    "team": "872815618512410358",
    "type": {
      "id": "872815618512410358",
      "name": {
        "en": "Hello",
        "fr": "Bonjour",
        "de": "Guten Tag"
      },
      "machine_name": "<string>",
      "display_mode": "normal",
      "is_on_call": true,
      "legacy_id": 123
    },
    "color": "<string>",
    "legacy_id": 123,
    "hour_ranges": [
      {
        "hour_range": "12:34:56/PT2H",
        "auto_correct": {
          "before_start": "PT1H30M20S",
          "after_start": "PT1H30M20S",
          "before_end": "PT1H30M20S",
          "after_end": "PT1H30M20S"
        },
        "paid_break": {
          "max_duration": "PT1H30M20S",
          "hour_range": "12:34:56/PT2H"
        }
      }
    ],
    "adjustment": {
      "value": "PT1H30M20S",
      "time": "12:34:56"
    },
    "tags": [
      "872815618512410358"
    ],
    "break_time": {
      "min_duration": "PT1H30M20S",
      "hour_range": "12:34:56/PT2H"
    },
    "validity": "2019-11-11/2019-12-12",
    "options": {
      "counts_in_balances": true,
      "timecheck_counted": true,
      "employee_resident_ratio": true,
      "auto_completable": true
    }
  }
]

Body

application/json
ids
string<snowflake>[] | null
teams
string<snowflake>[] | null
date_range
string<local-date-interval>
Example:

"2019-11-11/2019-12-12"

is_on_call
boolean | null

Response

200 - application/json
id
string<snowflake>
required
Example:

"872815618512410358"

name
object
required
Example:
{
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
}
description
object
required
Example:
{
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
}
team
string<snowflake>
required
Example:

"872815618512410358"

type
object
required
color
string
required
legacy_id
integer
required
hour_ranges
object[]
required
adjustment
object
required
tags
string<snowflake>[]
required
break_time
object
required
validity
string<local-date-interval>
required
Example:

"2019-11-11/2019-12-12"

options
object
required