getUsersメソッド

目的

getUsersメソッドを使用すると、組織内のユーザーの一覧を取得できます。

リクエストURL

XML形式：
https://crm.zoho.com/crm/private/xml/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User

JSON形式：
https://crm.zoho.com/crm/private/json/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User

リクエストパラメーター

パラメーターデータ型説明
authtoken*文字列Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*文字列値をcrmapiと指定してください。
newFormat整数newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。
newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。
version整数version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。
version = 2：最新のAPI実装に基づいてレスポンスを取得します。
type*文字列このパラメーターには、次のいずれかの値を指定してください。
AllUsers
組織内の全ユーザーの一覧を取得します。
ActiveUsers
有効な全ユーザーの一覧を取得します。
DeactiveUsers
無効化されている全ユーザーの一覧を取得します。
AdminUsers
管理者権限を持つ全ユーザーの一覧を取得します。
ActiveConfirmedAdmins
管理者権限を持つ、認証済みの全ユーザーの一覧を取得します。

* - 必須パラメーター

注：

  • API実装で行われた強化の詳細については、リリースノートページを参照してください。

レスポンス例

以下はtype = AllUsersの例です。

<users>
      <user id="501240000000541313" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
      <user id="501234132412341135" email="tyson@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="true">tyson</user>
      <user id="501234565431234521" email="kelly@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="false">kelly</user>
      <user id="512343454676898643" email="frank@zohocorp.com" role="CEO" profile="Standard" status="active" confirm="false">frank</user>
      <user id="512445678909865545" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>

version = 2の場合、レスポンスで組織idが返されます。ただし、レスポンスで組織idを取得するには、CRMデータに関する組織の詳細が登録されている必要があります。

<users orgid="501240000000652982">
      <user id="501240000000541313" zuid="11381966" website="null" mobile="888-555-2146" fax="null" street="null" city="null" state="null" country="null" zip="null" language="en_US" timezone="PST8PDT" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
      <user id="512445678909865545" zuid="11385946" website="null" mobile="null" fax="null" street="null" city="null" state="null" country="null" zip="null" language="en_US" timezone="America/Los_Angeles" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>