Skip to main content
GET
ユーザーを一覧取得

承認

Authorization
string
header
必須

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

クエリパラメータ

email
string<email>

メールアドレスの完全一致(大文字小文字は区別しない)で絞り込む。 properties.owner_id に入れる record_id を、担当者のメールアドレスから 1 往復で 引くための発見用フィルタ。識別子そのものではないため、解決した record_id を 保存して以降の参照に使うこと(メールアドレスは変更され得る)。 該当なしの場合は空の results を返す(404 ではない)。

updated_after
string<date-time>

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

limit
integer
デフォルト:100

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

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

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

レスポンス

一覧取得成功

results
object[]
必須
paging
object
必須

ページネーション情報