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

承認

Authorization
string
header
必須

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

パスパラメータ

record_id
string
必須

Stockwork record_id(18 文字英数字)

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

レスポンス

取得成功

Stockwork ユーザー(担当者)。read-only。 properties.owner_id 等が参照する先で、API キーの組織に所属するユーザーのみが見える。 公開するのは連携に必要な最小限の属性だけで、権限フラグや認証情報は含まない。

id
string
必須

Stockwork record_id(18 文字)

:

"Us7XkQpYz3Lh9vMs2N"

email
string<email>
必須

メールアドレス(Stockwork 全体で一意)

name
string
必須

表示名(姓 + 名)。未設定の場合は空文字列

is_active
boolean
必須

当該組織における所属が有効か