List Users(ユーザーの一覧表示)

現在Greenhouseにいる、組織のすべてのユーザーを一覧表示します。

オプション

フィールド 定義 タイプ 必須

結果セット(Result Set)

検索結果を表示するために次のオプションのいずれかを選択します。

  • First 200 Records

  • Stream Records:一致するすべてのレコードが親フローからヘルパーフローに渡されます。

    このオプションを選択すると、ストリーミング用のヘルパーフローを選択したりカスタム拡張可能フィールドを追加したりできるストリーミング(Streaming)入力セクションがカードに追加されます。

ドロップダウン

カスタム項目を含める(Include Custom Fields)

入力の更新オプションを選択します。

  • No:ユーザーのカスタムフィールドを含めません。これはデフォルトのオプションです。

  • Yes:ユーザーのカスタムフィールドを含めます。

ドロップダウン FALSE

入力

フィールド 定義 タイプ 必須

条件の一覧表示(List Criteria)

前に作成(Created Before)

指定したタイムスタンプの前に作成されたユーザーのみを返します。

タイムスタンプの形式はISO-8601でなければなりません。

日時 FALSE

後に作成(Created After)

指定したタイムスタンプの後に作成されたユーザーのみを返します。

タイムスタンプの形式はISO-8601でなければなりません。

日時 FALSE

前に更新(Updated Before)

指定したタイムスタンプの前に更新されたユーザーのみを返します。

タイムスタンプの形式はISO-8601でなければなりません。

日時 FALSE

後に更新(Updated After)

指定したタイムスタンプの後に更新されたユーザーのみを返します。

タイムスタンプの形式はISO-8601でなければなりません。

日時 FALSE

ストリーミング(Streaming)

フロー(Flow)

フローを選択(Choose Flow)をクリックして、検索結果ストリームを受信する宛先ヘルパーフローを選択します。選択(Choose)をクリックして確定します。

オプションとして、クリックまたはここにドロップして作成(Click or drop here to create)の下の空のフィールドをクリックし、データをヘルパーフローに渡すカスタム拡張可能フィールドを追加します。これらのフィールドは、ヘルパーフロー内の状態(State)出力オブジェクトの下にキーと値のペアとして追加されます。

このフィールドは、結果セット(Result Set)フィールドでStream Recordsを選択した場合に表示されます。

フロー

レコード制限(Record Limit)

ストリーミングするレコードの数を指定します。

  • レコード制限(Record Limit)フィールドに0または負の値を設定すると、カードはエラーを返します。

  • レコード制限(Record Limit)フィールドに0より大きい値を設定すると、最大で指定された最大レコード数までのレコードが返されます。

  • レコード制限(Record Limit)フィールドが空、null、または未選択の場合、すべてのレコードが返されます。

  • デフォルト値は500000です。

  • 有効な範囲は0500000です。

このフィールドは、結果セット(Result Set)フィールドでStream Recordsを選択した場合に表示されます。

数値 FALSE

List Users APIのドキュメントに登場するクエリパラメーターのemployee_idemailは、条件の一覧表示(List Criteria)には含まれません。このクエリは、Read Userカードと同様に単一ユーザーを返します。そのために、ユーザーの読み取り(Read User)カードではこれらのパラメーターは読み取り条件(Read By)オプションのEmailEmployee IDの選択肢として表示されます。

出力

フィールド 定義 タイプ

結果(Result)

このフィールドは、結果セット(Result Set)オプションでFirst 200 Recordsを選択した場合に表示されます。

このフィールドはオブジェクトのリストであり、各オブジェクトには次のフィールドが含まれます。

オブジェクトのリスト

ID

ユーザーの一意識別子。 数値

名前(Name)

ユーザーの名前。 テキスト

名(First Name)

ユーザーの名。 テキスト

姓(Last Name)

ユーザーの姓。 テキスト

プライマリメールアドレス(Primary Email Address)

このユーザーがプライマリアドレスとして指定したメールアドレス。

この値はメール(Emails)の結果に含まれます。

テキスト

更新日時(Updated At)

オブジェクトが更新された日時。

この値の形式はISO-8601です。

日時

作成日時(Created At)

オブジェクトが作成された日時。

この値の形式はISO-8601です。

日時

無効(Disabled)

ユーザーが無効化されている場合はtrueが返されます。

True/False

サイト管理者(Site Admin)

ユーザーがサイト管理者である場合はtrueが返されます。

True/False

メール(Emails)

このユーザーに関連付けられたメールアドレスのリスト。

テキストのリスト

社員ID(Employee ID)

ユーザーの一意の外部ID。 テキスト

リンクされた候補者ID(Linked Candidate IDs)

このユーザーの個人アプリケーションが含まれる候補者レコードのID。このユーザーの個人面接レコードなどの情報が含まれるレコードです。

数値のリスト

事務所(Offices)

このユーザーに関連付けられた事務所が含まれる配列。

オブジェクトのリスト

部署情報(Departments)

このユーザーに関連付けられた部署が含まれる配列。

オブジェクトのリスト

カスタムフィールド(Custom Fields)

組織に固有のすべてのカスタムユーザーフィールドが含まれるオブジェクト。

オブジェクトのリスト

結果(Result)

ストリーミングされたレコード(Records Streamed)

このフィールドは、結果セット(Result Set)オプションでStream Recordsを選択した場合に表示されます。

ストリーミングされたレコードの数。

数値