GET segmentation/preview

This method returns information which is included in the segment. Single segmentation is returned by each call

Available from CRM.COM R4.0.0

Resource URL

Parameters

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the segmentation

number

(semi-optional)

String

The number of the segmentation

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
entity_name	String	The name of the segmentation entity
entity_id	String	The id of the segmentation entity
entity_number	String	The number of the segmentation entity, if applicable
entity_alternative_code	String	The alternative code of the segmentation entity, if applicable
entity_description	String	The description of the segmentation entity, if applicable
accounts_receivable	Accounts Receivable Object	The Accounts Receivable of the segmented entity. Applicable only for Accounts Receivable-based entities and in cases in which the segment's entity is one of the following: BILLS BUYINADVANCEREQUESTS CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS PAYMENTS PAYMENTCANCELLATIONS PAYMENTGATEWAYCARDS PAYMENTGATEWAYREQUESTS REFUNDS REWARDAWARDTRANSACTIONS REWARDPARTICIPANTS REWARDSPENDTRANSACTIONS SERVICEREQUESTS SUBSCRIPTIONS WALLETS WRITEOFFS SUBSCRIPTIONACTIONS Available from CRM.COM R12.0.0 SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0 CREDITNOTES, INVOICES, INVOICECANCELLATIONS, REFUNDS, PAYMENTCANCELLATIONS, WALLETS, WRITEOFFS are available from CRM.COM R15.0.0
contact_information	Contact Information Object	The Contact Information of the segmented entity. Applicable only for Contact Information-based entities and in cases in which the segment's entity is one of the following: ACTIVITIES LEADS Available from CRM.COM R12.0.0 LEADS is available from CRM.COM R15.0.0

Referred Objects Response Data

segment_accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable

segment_contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
name	String	The full name of the retrieved contact information

Examples

Example 1

HTTP Method: GET

Request:

Response:

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "entity_description": null,
            "entity_number": "J000409",
            "entity_name": null,
            "entity_id": "3349DB8598845E977E27775A01093E6E",
            "entity_alternative_code": null
        },
        {
            "entity_description": "test desc1",
            "entity_number": "13",
            "entity_name": null,
            "entity_id": "37B285CE1C9874D60B7F26B9E06EF95C",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "80",
            "entity_name": null,
            "entity_id": "52EA8108A003E206B901099CD38E13E3",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "82",
            "entity_name": null,
            "entity_id": "5E9F01ECC7A71E1295AD7896E183F5B2",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "83",
            "entity_name": null,
            "entity_id": "96A77117BF2B72D88929188E5A9D5657",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "84",
            "entity_name": null,
            "entity_id": "B699D60C9B58D2B3689A0AD8A5FEF5F6",
            "entity_alternative_code": null
        },
        {
            "entity_description": null,
            "entity_number": "81",
            "entity_name": null,
            "entity_id": "E42FE581568977DE4482202055E5E66F",
            "entity_alternative_code": null
        }
    ]
}