Get Entity Score

Purpose

To get the entity score of a record.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}/Entity_Scores__s

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/v5/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 Keys

  • Positive_Scoreinteger

    Represents the positive score of the specified record.

  • Negative_Scoreinteger

    Represents the negative score of the specified record.

  • Touch_Point_Scoreinteger

    Represents the combined touch point score of the specified record.

  • Touch_Point_Positive_Scoreinteger

    Represents the positive touch point score of the specified record.

  • Touch_Point_Negative_Scoreinteger

    Represents the negative touch point score of the specified record.

  • Scoreinteger

    Represents the gross score of the specified 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_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have the required scope. Create a new client with valid scope. Refer to scope section above for more details.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read entity scores data. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

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

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • REQUIRED_PARAM_MISSINGHTTP 400

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

  • INVALID_DATAHTTP 400

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