REST API 文档

  • 获取所有用户
  • 获取管理员用户
  • 获取活跃用户
  • 获取休眠用户
  • 获取单个用户数据
+
    • 用户 API - 示例
      • 获取所有用户
      • 获取管理员用户
      • 获取活跃用户
      • 获取休眠用户
      • 获取单个用户数据

用户 API - 示例

使用用户 API,检索可用的CRM用户的基本信息。

获取所有用户

用途

获取 CRM 帐户中所有用户的列表。

请求 URL

https://www.zohoapis.com.cn/crm/v2/users?type=AllUsers

请求方法

GET

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/users?type=AllUsers

-X GET

-H "Authorization: Zoho-OAuthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

{
    "users": [
       {
            "country": null,
            "role": {
                "name": "CEO",
                "id": "410888000000015966"
            },
            "customize_info": {
                "notes_desc": null,
                "show_right_panel": true,
                "bc_view": null,
                "show_home": true,
                "unpin_recent_item": true
            },
            "city": null,
            "signature": null,
            "name_format": "Salutation,First Name,Last Name",
            "language": "en_US",
            "locale": "en_US",
            "personal_account": false,
            "ntc_notification_type": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                21,
                23,
                24,
                25,
                26,
                27,
                28,
                30,
                31,
                32,
                33,
                34,
                35,
                36,
                37,
                38,
                39,
                40,
                41,
                42
            ],
            "default_tab_group": "0",
            "street": null,
            "alias": null,
            "theme": {
                "normal_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "selected_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "new_background": "#313949",
                "background": "#F3F0EB",
                "screen": "stretched",
                "type": "default"
            },
            "id": "410888000000086001",
            "state": null,
            "country_locale": "en_IN",
            "fax": null,
            "first_name": "Particia",
            "email": "p.boyle@zylker.com",
            "telephony_enabled": false,
            "imap_status": false,
            "zip": null,
            "decimal_separator": "en_US",
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Administrator",
                "id": "410888000000015972"
            },
            "mobile": null,
            "last_name": "Boyle",
            "time_zone": "IST",
            "zuid": "11290182",
            "confirm": true,
            "rtl_enabled": false,
            "full_name": "Patricia Boyle",
            "phone": null,
            "dob": null,
            "date_format": "dd/MM/yyyy",
            "ntc_enabled": true,
            "status": "active"
        },
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "street": null,
            "alias": null,
            "id": "410888000000096009",
            "state": null,
            "country_locale": "en_US",
            "fax": null,
            "first_name": "Jennifer",
            "email": "Jennifertaylor@zylker.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Taylor",
            "time_zone": "IST",
            "zuid": null,
            "confirm": false,
            "full_name": "Jennifer Taylor",
            "phone": null,
            "dob": "null-null-null",
            "date_format": "MM/dd/yyyy",
            "status": "inactive"
        },
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "street": null,
            "alias": null,
            "id": "410888000000177023",
            "state": null,
            "country_locale": "en_LS",
            "fax": null,
            "first_name": "Richard",
            "email": "richard.thomson@zylker.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Thomson",
            "time_zone": "Asia/Kolkata",
            "zuid": null,
            "confirm": true,
            "full_name": "Richard Thomson",
            "phone": null,
            "dob": null,
            "date_format": "MM/dd/yyyy",
            "status": "deleted"
        },
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_IN",
            "locale": "en_IN",
            "street": null,
            "alias": null,
            "id": "410888000000309025",
            "state": null,
            "country_locale": "en_LS",
            "fax": null,
            "first_name": "Pooja",
            "email": "poojatrivedi@zylker.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Trivedi",
            "time_zone": "Asia/Kolkata",
            "zuid": "11485754",
            "confirm": true,
            "full_name": "Pooja Trivedi",
            "phone": null,
            "dob": null,
            "date_format": "MM/dd/yyyy",
            "status": "active"
        },
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "street": null,
            "alias": null,
            "id": "410888000000469041",
            "state": null,
            "country_locale": "en_IN",
            "fax": null,
            "first_name": "Charles",
            "email": "charlesjohnson@zylker.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Johnson",
            "time_zone": "IST",
            "zuid": "43791575",
            "confirm": true,
            "full_name": "Charles Johnson",
            "phone": null,
            "dob": null,
            "date_format": "dd/MM/yyyy",
            "status": "active"
        }
    ]
}
+

获取管理员用户

用途

获取 CRM 帐户中的管理员用户列表。

请求 URL

https://www.zohoapis.com.cn/crm/v2/users?type=AdminUsers

请求方法

GET

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/users?type=AdminUsers

-X GET

-H "Authorization: Zoho-OAuthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

{
    "users": [
       {
            "country": null,
            "role": {
                "name": "CEO",
                "id": "410888000000015966"
            },
            "customize_info": {
                "notes_desc": null,
                "show_right_panel": true,
                "bc_view": null,
                "show_home": true,
                "unpin_recent_item": true
            },
            "city": null,
            "signature": null,
            "name_format": "Salutation,First Name,Last Name",
            "language": "en_US",
            "locale": "en_US",
            "personal_account": false,
            "ntc_notification_type": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                21,
                23,
                24,
                25,
                26,
                27,
                28,
                30,
                31,
                32,
                33,
                34,
                35,
                36,
                37,
                38,
                39,
                40,
                41,
                42
            ],
            "default_tab_group": "0",
            "street": null,
            "alias": null,
            "theme": {
                "normal_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "selected_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "new_background": "#313949",
                "background": "#F3F0EB",
                "screen": "stretched",
                "type": "default"
            },
            "id": "410888000000086001",
            "state": null,
            "country_locale": "en_US",
            "fax": null,
            "first_name": "Patricia",
            "email": "p.boyle@zylker.com",
            "telephony_enabled": false,
            "imap_status": false,
            "zip": null,
            "decimal_separator": "en_US",
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Administrator",
                "id": "410888000000015972"
            },
            "mobile": null,
            "last_name": "Boyle",
            "time_zone": "IST",
            "zuid": "11290182",
            "confirm": true,
            "rtl_enabled": false,
            "full_name": "Patricia Boyle",
            "phone": null,
            "dob": null,
            "date_format": "dd/MM/yyyy",
            "ntc_enabled": true,
            "status": "active"
        }
    ]
}
+

获取活跃用户

用途

获取 CRM 帐户中活跃用户的列表。

请求 URL

https://www.zohoapis.com.cn/crm/v2/users?type=ActiveUsers

请求方法

GET

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/users?type=ActiveUsers

-X GET

-H "Authorization: Zoho-OAuthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

{
    "users": [
       {
            "country": null,
            "role": {
                "name": "CEO",
                "id": "410888000000015966"
            },
            "customize_info": {
                "notes_desc": null,
                "show_right_panel": true,
                "bc_view": null,
                "show_home": true,
                "unpin_recent_item": true
            },
            "city": null,
            "signature": null,
            "name_format": "Salutation,First Name,Last Name",
            "language": "en_US",
            "locale": "en_US",
            "personal_account": false,
            "ntc_notification_type": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                21,
                23,
                24,
                25,
                26,
                27,
                28,
                30,
                31,
                32,
                33,
                34,
                35,
                36,
                37,
                38,
                39,
                40,
                41,
                42
            ],
            "default_tab_group": "0",
            "street": null,
            "alias": null,
            "theme": {
                "normal_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "selected_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "new_background": "#313949",
                "background": "#F3F0EB",
                "screen": "stretched",
                "type": "default"
            },
            "id": "410888000000086001",
            "state": null,
            "country_locale": "en_IN",
            "fax": null,
            "first_name": "Patricia",
            "email": "p.boyle@zylker.com",
            "telephony_enabled": false,
            "imap_status": false,
            "zip": null,
            "decimal_separator": "en_US",
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Administrator",
                "id": "410888000000015972"
            },
            "mobile": null,
            "last_name": "Boyle",
            "time_zone": "IST",
            "zuid": "11290182",
            "confirm": true,
            "rtl_enabled": false,
            "full_name": "Patricia Boyle",
            "phone": null,
            "dob": null,
            "date_format": "dd/MM/yyyy",
            "ntc_enabled": true,
            "status": "active"
        },
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "street": null,
            "alias": null,
            "id": "410888000000309025",
            "state": null,
            "country_locale": "en_LS",
            "fax": null,
            "first_name": "Pooja",
            "email": "poojatrivedi@zylker.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Trivedi",
            "time_zone": "Asia/Kolkata",
            "zuid": "11485754",
            "confirm": true,
            "full_name": "Patricia STD",
            "phone": null,
            "dob": null,
            "date_format": "MM/dd/yyyy",
            "status": "active"
        },
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "street": null,
            "alias": null,
            "id": "410888000000469041",
            "state": null,
            "country_locale": "en_IN",
            "fax": null,
            "first_name": null,
            "email": "sriram.rajamanickam+std2@zohocorp.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Patricia STD 2",
            "time_zone": "IST",
            "zuid": "43791575",
            "confirm": true,
            "full_name": "Patricia STD 2",
            "phone": null,
            "dob": null,
            "date_format": "dd/MM/yyyy",
            "status": "active"
        }
    ]
}
+

获取休眠用户

用途

获取 CRM 帐户中休眠用户的列表

请求 URL

https://www.zohoapis.com.cn/crm/v2/users?type=DeactivateUsers

请求方法

GET

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/users?type=DeactivateUsers"

-X GET

-H "Authorization: Zoho-OAuthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

{
    "users": [
       {
            "country": null,
            "role": {
                "name": "Manager",
                "id": "410888000000015969"
            },
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "street": null,
            "alias": null,
            "id": "410888000000096009",
            "state": null,
            "country_locale": "en_US",
            "fax": null,
            "first_name": "Jennifer",
            "email": "jennifertaylor@zylker.com",
            "zip": null,
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Standard",
                "id": "410888000000015975"
            },
            "mobile": null,
            "last_name": "Taylor",
            "time_zone": "Asia/Kolkata",
            "zuid": null,
            "confirm": false,
            "full_name": "Jennifer Taylor",
            "phone": null,
            "dob": "null-null-null",
            "date_format": "MM/dd/yyyy",
            "status": "inactive"
        }
    ]
}
+

获取单个用户数据

用途

获取任何特定用户的详细信息。在您的 API 请求中指定用户的唯一 ID 来获取该特定用户的数据。

请求 URL

https://www.zohoapis.com.cn/crm/v2/api/users/{id}

请求方法

GET

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/users/4108880000469041

-X GET

-H "Authorization: Zoho-OAuthtoken d92d401c803988c5cb849d0b4215f52

参数名称 数据类型 描述
id* 整型 指定用户的唯一 ID。
复制样本代码

样本响应:

{
    "users": [
       {
            "country": null,
            "role": {
                "name": "CEO",
                "id": "410888000000015966"
            },
            "customize_info": {
                "notes_desc": null,
                "show_right_panel": true,
                "bc_view": null,
                "show_home": true,
                "unpin_recent_item": true
            },
            "city": null,
            "signature": null,
            "name_format": "Salutation,First Name,Last Name",
            "language": "en_US",
            "locale": "en_US",
            "personal_account": false,
            "ntc_notification_type": [
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                21,
                23,
                24,
                25,
                26,
                27,
                28,
                30,
                31,
                32,
                33,
                34,
                35,
                36,
                37,
                38,
                39,
                40,
                41,
                42
            ],
            "default_tab_group": "0",
            "street": null,
            "alias": null,
            "theme": {
                "normal_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "selected_tab": {
                    "font_color": "#FFFFFF",
                    "background": "#222222"
                },
                "new_background": "#313949",
                "background": "#F3F0EB",
                "screen": "stretched",
                "type": "default"
            },
            "id": "410888000000086001",
            "state": null,
            "country_locale": "en_IN",
            "fax": null,
            "first_name": "Ram",
            "email": "sriram.rajamanickam@zohocorp.com",
            "telephony_enabled": false,
            "imap_status": false,
            "zip": null,
            "decimal_separator": "en_US",
            "website": null,
            "time_format": "hh:mm a",
            "profile": {
                "name": "Administrator",
                "id": "410888000000015972"
            },
            "mobile": null,
            "last_name": "Sri ADM",
            "time_zone": "IST",
            "zuid": "11290182",
            "confirm": true,
            "rtl_enabled": false,
            "full_name": "Patricia Boyle",
            "phone": null,
            "dob": "--",
            "date_format": "dd/MM/yyyy",
            "ntc_enabled": true,
            "status": "active"
        }
    ]
}
+