Skip to content

Getting all visitors with contact information for a person_id

Getting all visitors with contact information for a person_id

Method get.person_visitors
Description Getting all visitors with contact information for a person_id
Available to Agent, Client
Required components Data API for configuration
Method weight 1 point

Request parameters

Name Type Required Description
access_token string yes Authentication session key
user_id number no Unique identifier of the customer's user on whose behalf the request is made. Required for the agent. To obtain a list of customer users, call "get.customer_users".
person_id number yes Unique person identifier

Response parameters

Name Type Required Description
person_id number yes Unique person identifier
visitor_id number yes Unique identifier of the visitor on the site
name string no Visitor's name
phones array no Visitor's phone numbers
emails array no Visitor's email addresses
company string no Visitor's company
commentary string no Comment

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "get.person_visitors",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "person_id": "number"
    }
}

Response structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            {
                "person_id": "number",
                "visitor_id": "number",
                "name": "string",
                "emails": [ "email" ],
                "phones": [ "phone" ],
                "company": "string",
                "commentary": "string"
            }
        ]
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "rMiS6Y5qt1OYo2m9S3S3z",
    "result": {
        "data": [
            {
                "name": "test",
                "emails": [ "test@1.ae", "test@2.ae" ],
                "phones": [ "213123123213", "43534534543" ],
                "company": "The Best Luxury Properties",
                "person_id": 6145241079,
                "commentary": "Some comment",
                "visitor_id": 6152759362
            },
            {
                "name": "346356",
                "emails": [ "qere4@fsdfsd.ry" ],
                "phones": [ "213123123213", "74564565465" ],
                "company": null,
                "person_id": 6145241079,
                "commentary": null,
                "visitor_id": 6152759377
            }
        ]
    }
}

List of returned errors

See "Errors for get methods".