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

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

オプション

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

結果セット(Result Set)

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

  • First 200 Records

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

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

ドロップダウン

入力

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

条件の一覧表示(List Criteria)

前に作成(Created Before)

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

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

日時 FALSE

後に作成(Created After)

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

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

日時 FALSE

前に更新(Updated Before)

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

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

日時 FALSE

後に更新(Updated After)

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

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

日時 FALSE

事業所ID(Office IDs)

指定した場合、結果には指定されたオフィスIDに関連付けられたユーザーのみが返されます。

複数のオフィスIDをカンマ区切りの文字列として指定します。例:office_ids=123,456,789

この方法で指定できるIDは最大50件です。

テキスト FALSE

部門ID(Department IDs)

指定した場合、結果には指定された部門IDに関連付けられたユーザーのみが返されます。

複数の部門IDをカンマ区切りの文字列として指定します。例:department_ids=123,456,789

この方法で指定できるIDは最大50件です。

テキスト FALSE

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

指定した場合、結果には指定された候補者IDに関連付けられたユーザーのみが返されます。

複数の候補者IDをカンマ区切りの文字列として指定します。例:linked_candidate_ids=123,456,789

この方法で指定できるIDは最大50件です。

テキスト FALSE

面接担当者タグID(Interviewer Tag IDs)

指定した場合、結果には指定された面接担当者タグIDに関連付けられたユーザーのみが返されます。

複数の面接担当者タグIDをカンマ区切りの文字列として指定します。例:interviewer_tag_ids=123,456,789

この方法で指定できるIDは最大50件です。

テキスト FALSE

無効化済み(Is Deactivated)

指定した場合、結果には非アクティブ化のステータスに基づいてユーザーが返されます。

非アクティブ化されたユーザーのみを返すには、trueに設定します。アクティブなユーザーのみを返すには、falseに設定します。

True/False FALSE

カスタムフィルター(Custom Filters)

フィルター

検索の柔軟性を高めるために、値を使用してユーザーAPI属性名を指定してください。

フィルターはキーと値のペアとして指定し、&で区切ります。例:attr1=value1&attr2=value2&attr3=value3

テキスト 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)

ユーザーの姓。 テキスト

希望呼称(Preferred Name)

ユーザーの優先名。

テキスト

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

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

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

テキスト

タイムゾーン

ユーザーのタイムゾーン。

テキスト

更新日時(Updated At)

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

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

日時

作成日時(Created At)

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

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

日時

非アクティブ(Deactivated)

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

True/False

サイト管理者(Site Admin)

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

True/False

メール(Emails)

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

テキストのリスト

社員ID(Employee ID)

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

エージェンシーID(Agency ID)

ユーザーに関連付けられているエージェントの一意の識別子。

テキスト

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

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

数値のリスト

事業所ID(Offices IDs)

このユーザーに関連付けられている事業所IDの配列。このリストには、事業所IDが1つも含まれない場合、1つ含まれる場合、または複数含まれる場合があります。

数値のリスト

部門ID(Departments IDs)

このユーザーに関連付けられている部門IDの配列。このリストには、部門IDが1つも含まれない場合、1つ含まれる場合、または複数含まれる場合があります。

数値のリスト

面接担当者タグ(Interviewer Tags)

このユーザーに関連付けられている面接担当者タグのIDと名前を含む配列。

オブジェクトのリスト

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

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

オブジェクトのリスト

結果(Result)

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

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

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

数値