Users Data

GET {{api-domain}}/crm/v4/users?type=AllUsers

To retrieve the users' data specified in the API request. You can specify the type of users that needs to be retrieved using the Users API. For example, use type=AllUsers, to get the list of all the CRM users available.

Refer to help doc to know more.

Request Params

KeyDatatypeRequiredDescription
typestring

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"users":[{"country":null,"language":"en_US","microsoft":false,"$shift_effective_from":null,"Currency":"DZD","id":"4876876000000327001","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2021-08-09T09:51:46+05:30","time_format":"hh:mm a","offset":19800000,"profile":{"name":"Administrator","id":"4876876000000026011"},"created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":"756415895","full_name":"Patricia Boyle","phone":"Not Applicable","dob":null,"status":"active","role":{"name":"CEO","id":"4876876000000026005"},"customize_info":{"notes_desc":null,"show_right_panel":null,"bc_view":null,"show_home":false,"show_detail_view":true,"unpin_recent_item":null},"city":null,"signature":"Best Regards\u003cbr\u003ePatricia","sort_order_preference":"First Name,Last Name","name_format":"Salutation,First Name,Last Name","locale":"en_US","personal_account":false,"Isonline":true,"default_tab_group":"0","Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"street":null,"$current_shift":null,"alias":null,"theme":{"normal_tab":{"font_color":"#FFFFFF","background":"#222222"},"selected_tab":{"font_color":"#FFFFFF","background":"#222222"},"new_background":null,"background":"#F3F0EB","screen":"fixed","type":"default"},"first_name":"Patricia","email":"patricia.boyle@zohocorp.com","website":null,"Modified_Time":"2022-05-17T14:21:40+05:30","$next_shift":null,"mobile":"Not Applicable","last_name":"Boyle","time_zone":"Asia/Kolkata","number_separator":"Comma","confirm":true,"date_format":"MMM d, yyyy","category":"regular_user"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":"DZD","alias":null,"id":"4876876000000338114","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Sid","email":"sid.j@abc.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2021-08-09T16:29:49+05:30","website":null,"Modified_Time":"2022-05-17T14:22:13+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":"J","time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Sid J","phone":null,"dob":null,"date_format":"MMM d, yyyy","category":"regular_user","status":"active"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":null,"alias":null,"id":"4876876000001073004","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Patricia","email":"newtocrm@zoho.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2022-05-09T11:56:31+05:30","website":null,"Modified_Time":"2022-05-09T11:58:26+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":"Boyle","time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Patricia Boyle","phone":"123456789","dob":"1990-12-31","date_format":"MMM d, yyyy","category":"regular_user","status":"deleted"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":null,"alias":null,"id":"4876876000001073031","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Patricia","email":"patricia@abcl.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2022-05-09T12:03:02+05:30","website":null,"Modified_Time":"2022-05-17T14:13:54+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":"Boyle","time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Patricia Boyle","phone":null,"dob":null,"date_format":"MMM d, yyyy","category":"regular_user","status":"disabled"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":null,"alias":null,"id":"4876876000001212004","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Patricia","email":"patricia@abcde.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2022-05-17T14:08:21+05:30","website":null,"Modified_Time":"2022-05-17T14:13:54+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":"Boyle","time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Patricia Boyle","phone":null,"dob":null,"date_format":"MMM d, yyyy","category":"regular_user","status":"disabled"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":null,"alias":null,"id":"4876876000001212017","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Patricia","email":"patricia@abcdef.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2022-05-17T14:09:12+05:30","website":null,"Modified_Time":"2022-05-17T14:13:46+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":null,"time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Patricia","phone":null,"dob":null,"date_format":"MMM d, yyyy","category":"regular_user","status":"disabled"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":null,"alias":null,"id":"4876876000001212028","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Patricia","email":"patricia@xyz.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2022-05-17T14:14:18+05:30","website":null,"Modified_Time":"2022-05-17T14:14:18+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":null,"time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Patricia","phone":null,"dob":null,"date_format":"MMM d, yyyy","category":"regular_user","status":"active"},{"country":null,"role":{"name":"Manager","id":"4876876000000026008"},"city":null,"sort_order_preference":"null","language":"en_US","locale":"en_US","microsoft":false,"Isonline":false,"Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$shift_effective_from":null,"street":null,"$current_shift":null,"Currency":null,"alias":null,"id":"4876876000001212041","state":null,"fax":null,"country_locale":"en_US","sandboxDeveloper":false,"first_name":"Patricia","email":"patricia@abcld.com","Reporting_To":null,"zip":null,"decimal_separator":"Period","created_time":"2022-05-17T14:18:13+05:30","website":null,"Modified_Time":"2022-05-17T14:18:13+05:30","time_format":"hh:mm a","$next_shift":null,"offset":19800000,"profile":{"name":"Standard","id":"4876876000000026014"},"mobile":null,"last_name":"Boyle","time_zone":"Asia/Kolkata","number_separator":"Comma","created_by":{"name":"Patricia Boyle","id":"4876876000000327001"},"zuid":null,"confirm":false,"full_name":"Patricia Boyle","phone":null,"dob":null,"date_format":"MMM d, yyyy","category":"regular_user","status":"active"}],"info":{"per_page":200,"count":8,"page":1,"more_records":false}}