全ユーザーの詳細取得
説明
このAPIを使用すると、ページネーションを通じて特定のアプリケーションのすべてのCatalystアプリケーションユーザーの詳細を取得できます。ページネーションにより、API呼び出しの反復を通じてユーザーリストをページ単位で取得できます。
たとえば、ユーザーレコードを200件ずつ個別のページとして取得する場合、リクエストにstartとendパラメータを含める必要があります。startパラメータを使用して開始インデックスを0に設定し、endパラメータを使用して取得するユーザーの最大数を200に指定できます。次のユーザーレコードセットを取得するには、startインデックスを200に設定し、endパラメータを使用してそのページのユーザーレコード数を適宜指定して、別のAPI呼び出しを実行できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user?start={start_index}&end={number_of_users}
ユーザーレコードの取得を開始する開始インデックス
ページネーションを通じて1ページで返すユーザーレコード数
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.READ
レスポンス詳細
レスポンスには、zuid、user_id、email_idなどの識別値やロール詳細を含む、すべてのアプリケーションユーザーの詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user?start=100&end=3
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"zuid": 3171930121,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App User",
"is_confirmed": true,
"email_id": "ron.grisham@zylker.com",
"first_name": "Ronald",
"last_name": "Grisham",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
},
{
"zuid": 3171930089,
"zaaid": 1019543293,
"status": "ACTIVE",
"user_id": 671930121,
"user_type": "App User",
"is_confirmed": true,
"email_id": "Lucy.p@zylker.com",
"first_name": "Lucy",
"last_name": "Pettigrew",
"created_time": "Jul 09, 2019 04:26 PM",
"modified_time": "Jul 09, 2019 04:26 PM",
"invited_time": "Jul 09, 2019 04:26 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
},
{
"zuid": 3171937685,
"zaaid": 1019540091,
"status": "ACTIVE",
"user_id": 671930888,
"user_type": "App User",
"is_confirmed": true,
"email_id": "zayn.ahmed@zylker.com",
"first_name": "Zayn",
"last_name": "Ahmed",
"created_time": "Jul 09, 2019 04:26 PM",
"modified_time": "Jul 09, 2019 04:26 PM",
"invited_time": "Jul 09, 2019 04:26 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
]
}
Yes
No
Thank you for your feedback!
Send your feedback to us