GET users/list

Available from CRM.COM R8.0.0

This method returns information related with users. Multiple users are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

business_unit_identifier

(semi-optional)

Business Unit Identifier

The identifier of the business unit to which users that will be returned belong to. The allowed business units identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

Available from CRM.COM R18.0.0

unit_identifier

(semi-optional)

Unit Identifier

The identifier of the organisational unit to which users that will be returned belong to. The allowed organisational units identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

Deprecated from CRM.COM R18.0.0

group_identifier

(semi-optional)

Group Identifier

The identifier of the group in which the users that should be returned as a result belong to. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

Deprecated from CRM.COM R18.0.0

security_profile_identifier

(semi-optional)

Security Profile Identifier

The identifier of the Security profile which is assigned to users that should be returned. The allowed security profile identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Security Profile

name

(semi-optional)

String

The name of the Security Profile

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The username of the retrieved user
active	Boolean	Indicates whether the user's account is active or not
domain	String	The user's domain
developer	Boolean	Indicates whether the user is a developer or not
super_user	Boolean	Indicates whether the user is a superuser or not
system_user	Boolean	Indicates whether the user is a system user or not Available from CRM.COM R15.0.0
person_name	String	The user's person name
cti_enabled	Boolean	Indicates whether the user's account is CTI enabled or not
cti_phone_extension_number	String	The extension number of the phone device of this user and only if the user's account is CTI enabled
ip_address	String	The user's IP address
email	String	The user's email
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
contact_information	Contact Information Object	The user's related Contact Information
log_information	Log Information Object	The log information related with the retrieved user
security_profile	Security Profile Object	The user's Security Profile
units_set	Set of User Units Objects	The set of Units to which the user belongs to

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

security_profile object response data

Name	Type	Description
id	String	The id of the security profile
name	String	The name of the retrieved security profile
description	String	The description of the retrieved security profile

user unit object response data

Name	Type	Description
id	String	The ID of the retrieved user unit
default	Boolean	Identifies if the retrieved user unit is the default unit for that user or not
unit	Unit Object	The description of the retrieved unit Deprecated from CRM.COM R18.0.0
business_unit	Business Unit Object	The description of the retrieved business unit Available from CRM.COM R18.0.0

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "cti_phone_extension_number": null,
            "domain": null,
            "udf_float_1": null,
            "active": true,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "developer": true,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "contact_information":
            {
                "last_name": "DEMO",
                "middle_name": null,
                "life_cycle_state": "MARKETING",
                "company_profile": null,
                "title": null,
                "first_name": "CRM",
                "type": "PERSON",
                "name": "DEMO CRM",
                "id": "2043BAA62B6EC8DC108B30EA560D8044",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence": null,
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "id_number": null,
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "udf_string_4": null,
            "super_user": true,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "units_set":
            [
                {
                    "default": true,
                    "unit":
                    {
                        "community_name": "Internal Community",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "id": "BCB6DD2B294FFA6D67C9B0C1E5C209F9"
                }
            ],
            "udf_string_8": null,
            "username": "crmdemo",
            "cti_enabled": false,
            "id": "EE45E7939403344B3AA5F7B8BAC55455",
            "email": null,
            "ip_address": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "security_profile":
            {
                "id": "0C61DE1F3012D926A31BC22A7D804EC9",
                "name": "Administrators",
                "description": "Administrators security profile"
            },
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2013-07-05T10:53:35",
                "created_date": "2012-05-09T12:34:47",
                "created_by_unit": null,
                "updated_by_unit": null,
                "created_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "person_name": "CRM DEMO"
        },
        {
            "cti_phone_extension_number": "3",
            "domain": null,
            "udf_float_1": null,
            "active": true,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "developer": true,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "contact_information":
            {
                "last_name": "Brown",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Simon",
                "type": "PERSON",
                "name": "Brown Simon",
                "id": "99A9AF3ACF4991ED5E1DB1DEFB72209A",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "social_security_number": "230664",
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence":
                    {
                        "three_character_code": "GBR",
                        "two_character_code": "GB",
                        "id": "126",
                        "name": "UNITED KINGDOM",
                        "alternative_code": null
                    },
                    "name_day":
                    {
                        "month": 1,
                        "day": 1
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1947
                    },
                    "id_number": "895623",
                    "industry": null,
                    "id_issued_by_country":
                    {
                        "three_character_code": "GBR",
                        "two_character_code": "GB",
                        "id": "126",
                        "name": "UNITED KINGDOM",
                        "alternative_code": null
                    }
                }
            },
            "udf_string_4": null,
            "super_user": true,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "units_set":
            [
                {
                    "default": false,
                    "unit":
                    {
                        "community_name": "Internal Community",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "id": "074BEA97F60C64E2C58C2E9435D0AFA2"
                }
            ],
            "udf_string_8": null,
            "username": "DELBOY",
            "cti_enabled": true,
            "id": "29DE94EBF89A885822BAB8179F2F2686",
            "email": null,
            "ip_address": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "security_profile":
            {
                "id": "0C61DE1F3012D926A31BC22A7D804EC9",
                "name": "Administrators",
                "description": "Administrators security profile"
            },
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2014-06-18T11:51:40",
                "created_date": "2012-05-11T11:17:30",
                "created_by_unit": null,
                "updated_by_unit":
                {
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "person_name": "Simon Brown"
        },
        {
            "cti_phone_extension_number": "102",
            "domain": null,
            "udf_float_1": null,
            "active": true,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "developer": true,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "contact_information":
            {
                "last_name": "Lecterious",
                "middle_name": null,
                "life_cycle_state": "MARKETING",
                "company_profile": null,
                "title": "Dr.",
                "first_name": "Hannibal",
                "type": "PERSON",
                "name": "Lecterious Hannibal",
                "id": "29D1F497C175714D259443023BBBF7AC",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence":
                    {
                        "three_character_code": "CYP",
                        "two_character_code": "CY",
                        "id": "181",
                        "name": "CYPRUS",
                        "alternative_code": null
                    },
                    "name_day":
                    {
                        "month": 9,
                        "day": 6
                    },
                    "date_of_birth":
                    {
                        "month": 9,
                        "day": 8,
                        "year": 1967
                    },
                    "id_number": null,
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "udf_string_4": null,
            "super_user": false,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "units_set":
            [
                {
                    "default": true,
                    "unit":
                    {
                        "community_name": "Main Community",
                        "id": "C4370788B2630BC8A99E8C7397406C09",
                        "name": "Developers Unit",
                        "group_name": "Developers Group",
                        "description": null,
                        "alternative_code": null
                    },
                    "id": "B5C96060042A1E2408DAD8B8E01FFD8A"
                }
            ],
            "udf_string_8": null,
            "username": "hannibal",
            "cti_enabled": true,
            "id": "2C008EB82E0DBC7722E93F207E2091CE",
            "email": "hannibal@crm.com",
            "ip_address": null,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "security_profile":
            {
                "id": "0C61DE1F3012D926A31BC22A7D804EC9",
                "name": "Administrators",
                "description": "Administrators security profile"
            },
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2013-07-23T14:34:11",
                "created_date": "2013-06-25T14:48:45",
                "created_by_unit": null,
                "updated_by_unit": null,
                "created_by_user":
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "Rossides Giorkos",
                    "username": "g_rossides",
                    "id": "4AD9C84FA60F9FE407140E20F707726A",
                    "email": "george.rossides@crm.com"
                }
            },
            "person_name": "Hannibal Lecterious"
        },
....
 ]
}