Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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

...

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


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:

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

...