Page Comparison

...

Tip
Available from CRM.COM R8.0.0 Deprecated from CRM.COM R18.0.0

Excerpt
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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

Tip
Available from CRM.COM

...

R18.0.0

...

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

...

Name

Type

Description

token

String

The token retrieved from the login method

Parameters

unit_identifier

(semi-optional)

Identifier

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

Tip
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:

Include Page

	V4:group_identifier
	V4:group_identifier

Tip
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:

Include Page

	V4:security_profile_identifier
	V4:security_profile_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip
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

Tip
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.

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "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"
        },
....
 ]
}

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Parameters

Restrictions