Skip to main content
POST
/
api
/
schedule
/
schedules.list
List schedules
curl --request POST \
  --url https://api.example.com/api/schedule/schedules.list \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_range": "2019-11-11/2019-12-12",
  "ids": [
    "872815618512410358"
  ],
  "resources": [
    "872815618512410358"
  ]
}
'
[
  {
    "id": "872815618512410358",
    "resource": "872815618512410358",
    "team": "872815618512410358",
    "time_ranges": [
      {
        "time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
        "auto_correct": {
          "before_start": "PT1H30M20S",
          "after_start": "PT1H30M20S",
          "before_end": "PT1H30M20S",
          "after_end": "PT1H30M20S"
        },
        "paid_break": {
          "max_duration": "PT1H30M20S",
          "time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
        }
      }
    ],
    "schedule_template": {
      "id": "872815618512410358",
      "name": "<string>",
      "description": "<string>",
      "color": "<string>"
    },
    "remark": "<string>",
    "modified": true,
    "adjustment": {
      "value": "PT1H30M20S",
      "time": "2019-11-11T12:34:56"
    },
    "break_time": {
      "min_duration": "PT1H30M20S",
      "time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59"
    },
    "options": {
      "employee_resident_ratio": true,
      "text_color": "<string>",
      "special_hours": "2019-11-11T12:34:56/2019-12-12T23:59:59"
    }
  }
]

Body

application/json
date_range
string<local-date-interval>
required
Example:

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

ids
string<snowflake>[] | null
resources
string<snowflake>[] | null

Response

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

"872815618512410358"

resource
string<snowflake>
required
Example:

"872815618512410358"

team
string<snowflake>
required
Example:

"872815618512410358"

time_ranges
object[]
required
schedule_template
object
required
remark
string
required
modified
boolean
required
adjustment
object
required
break_time
object
required
options
object
required