メインコンテンツへスキップ
GET
予定を一覧取得

承認

Authorization
string
header
必須

Stockwork が発行する API キー(sk_ プレフィックス、base62 ランダム ≥ 40 文字)。 キーには 1 つの role(read / analyst / write / admin)が紐付き、 各エンドポイントの必要 role 以上であることが要求される(対応表は info.description 参照)。

クエリパラメータ

start_after
string<date-time>

開始時刻がこの日時以降(start_time >= 値)の予定のみを返す

start_before
string<date-time>

開始時刻がこの日時より前(start_time < 値)の予定のみを返す

owner_id
string

予定の持ち主(ユーザーの record_id)で絞り込む

Pattern: ^[A-Za-z0-9]{18}$
meeting_key
string

同じ会議の予定だけを返す。値は CalendarEvent.meeting_key をそのまま渡す

include_cancelled
boolean
デフォルト:false

true のとき、キャンセルされた予定(status: cancelled)も返す。 updated_after による差分同期ではキャンセルを取りこぼさないよう true を推奨する

updated_after
string<date-time>

指定日時以降に更新されたレコードのみを返す

limit
integer
デフォルト:100

1 ページあたりの最大件数

必須範囲: 1 <= x <= 200
after
string

次ページ取得用カーソル。前回レスポンスの paging.next.after をそのまま渡す

レスポンス

一覧取得成功

results
object[]
必須
paging
object
必須

ページネーション情報