Get Entity Score

Purpose

To get the entity score of a record.

Endpoints

  • GET /{module_api_name}/{record_ID}/Entity_Scores__s?fields={field1,field2,..}

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_ID}/Entity_Scores__s?fields={field1, field2,..}

Supported modules

Leads, Accounts, Contacts, Deals and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.entity_scores.READ
(and)
ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, deals and custom

Possible operation types

ALL - Full access to module data
READ - Get module data

Parameters

  • fieldsstring, mandatory

    Specify the API names of the fields whose details you want to receive in the response.
    Possible Values: Positive_Score, Negative_Score, Touch_Point_Score, Touch_Point_Positive_Score, Touch_Point_Negative_Score, Score, Scoring_Rule

Note

For non-people modules, touch point scores will always be null.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/487687600000038603/Entity_Scores__s?fields=Positive_Score,Negative_Score,Touch_Point_Score,Touch_Point_Positive_Score,Touch_Point_Negative_Score,Score,Scoring_Rule"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

Response JSON

  • Positive_Scoreinteger

    Represents the positive score of the record.

  • Negative_Scoreinteger

    Represents the negative score of the record.

  • Touch_Point_Scoreinteger

    Represents the combined touch point score of the record.

  • Touch_Point_Positive_Scoreinteger

    Represents the positive touch point score of the record.

  • Touch_Point_Negative_Scoreinteger

    Represents the negative touch point score of the record.

  • Scoreinteger

    Represents the gross score of the record.

  • idstring

    Represents the entity score ID.

  • Scoring_RuleJSON object

    Represents the scoring rule ID and name.

Sample Response

Copied{
    "data": [
        {
            "Positive_Score": 18,
            "Touch_Point_Score": null,
            "Score": 18,
            "Negative_Score": null,
            "Touch_Point_Negative_Score": null,
            "Scoring_Rule": {
                "name": null,
                "id": "4876876000002750002"
            },
            "id": "4876876000002768054",
            "Touch_Point_Positive_Score": null
        },
        {
            "Positive_Score": 15,
            "Touch_Point_Score": null,
            "Score": 10,
            "Negative_Score": -5,
            "Touch_Point_Negative_Score": null,
            "Scoring_Rule": {
                "name": null,
                "id": "4876876000002741001"
            },
            "id": "4876876000002768021",
            "Touch_Point_Positive_Score": null
        }
    ],
    "info": {
        "per_page": 200,
        "next_page_token": null,
        "count": 2,
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": null,
        "more_records": false
    }
}

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The request method is incorrect.
    Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error.

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: Specify the fields parameter. Refer to the parameters section for more details.

  • INVALID_DATAHTTP 400

    The related ID given seems to be invalid
    Resolution: Specify a valid record ID.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    The access token you have used to make this API call does not have the required scope.
    Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes.

  • NO_PERMISSIONHTTP 403

    You do not have permission to read entity score.
    Resolution: Contact your system administrator.

  • INVALID_URL_PATTERNHTTP 404

    The request URL is incorrect.
    Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.