| Tip |
|---|
Available from CRM.COM R4.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET segmentation/
...
GET segmentation/show
This method returns information related with a segmentation. Single segmentation is returned by each call
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| segmentation_identifier (mandatory) | Identifier | The identifier of the segmentation that should be returned as a result. The allowed segmentation identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| segmentation_identifier (mandatory) | Identifier | The identifier of the segmentation that should be returned as a result. The allowed segmentation identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| segmentation_identifier (mandatory) | Identifier | The identifier of the segmentation that should be returned as a result. The allowed segmentation identifier fields are the following:
| ||||||
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 |
...
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
...
Name | Type | Description |
|---|---|---|
token | String | The token retrieved from the login method |
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_string_9 (optional) | String | User Defined Field of type String |
udf_string_10 (optional) | String | User Defined Field of type String |
udf_string_11 (optional) | String | User Defined Field of type String |
udf_string_12 (optional) | String | User Defined Field of type String |
udf_string_13 (optional) | String | User Defined Field of type String |
udf_string_14 (optional) | String | User Defined Field of type String |
udf_string_15 (optional) | String | User Defined Field of type String |
udf_string_16 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_float_5 (optional) | Float | User Defined Field of type Float |
udf_float_6 (optional) | Float | User Defined Field of type Float |
udf_float_7 (optional) | Float | User Defined Field of type Float |
udf_float_8 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
udf_date_5 (optional) | Date | User Defined Field of type Date |
udf_date_6 (optional) | Date | User Defined Field of type Date |
udf_date_7 (optional) | Date | User Defined Field of type Date |
udf_date_8 (optional) | Date | User Defined Field of type Date |
(mandatory) | Log Information Object | The log information related with the communication |
...
| segmentation_identifier (mandatory) | Identifier | The identifier of the segmentation that should be returned as a result. The allowed segmentation identifier fields are the following:
| ||||||
entity (mandatory) | String | The entity of the retrieved segment which can be CONTACT_INFORMATION, SUBSCRIPTIONS, ACCOUNTS_RECEIVABLE, BILLS, ACTIVITIES, JOBS |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|