Get all Contacts

Get Contacts

GET https://{{workspace}}.myeshopbox.com/api/v1/contacts

This method retrieves list of contacts in workspace

Query Parameters

Name	Type	Description
page	integer	The number of pages used to offset the results
per_page	integer	The number of items to be return per page

Headers

Name	Type	Description
Authorization	string	The Bearer token is required to access API

200 Contacts details successfully retrieved

{
    "data": [
        {
            "accountSlug": "montecarlo",
            "networkKey": "raymond",
            "refPartyId": "MCE00365",
            "partyName": "MONTE CARLO FASHIONS LTD.UNIT-1",
            "type": "Billing",
            "gstin": "03AAJXBJ82ZK",
           "address": {
                "country": "India",
                "pincode": "421305",
                "city": "Thane",
                "state": "Maharashtra",
                "addressLine": "Raymond Apparels Limited,Saidhara Bhiwandi"
            },
            "status": "active",
            "contactType": "location",
            "contact": {
                "phoneNumber": "9876543876",
                "email": "[e-mail]"
            },
            "customField": [
                {
                    "label": "occassion",
                    "internalName": "occassion",
                    "value": [
                        "eid"
                    ]
                }
            ],
            "createdAt": "2019-04-08T12:41:05.000+05:30",
            "updatedAt": "2019-04-08T12:41:05.000+05:30"
        },
        {
            "accountSlug": "montecarlo",
            "networkKey": "blackberry",
            "refPartyId": "pw50",
            "partyName": "MONTE CARLO FASHIONS LTD.UNIT-2",
            "type": "Billing",
            "gstin": "03AAJXBJ82ZK",
           "address": {
                "country": "India",
                "pincode": "421305",
                "city": "Thane",
                "state": "Maharashtra",
                "addressLine": "Raymond Apparels Limited,Saidhara Bhiwandi"
            },
            "status": "active",
            "contactType": "vendors",
            "contact": {
                "phoneNumber": "9876543876",
                "email": "[e-mail]"
            },
            "customField": [
                {
                    "label": "fabric",
                    "internalName": "fabric",
                    "value": [
                        "cotton"
                    ]
                }
            ],
            "createdAt": "2019-04-08T15:41:05.000+05:30",
            "updatedAt": "2019-04-08T15:41:05.000+05:30"
        }
    ],
    "total": 120,
    "page": 1,
    "per_page": 10
}

cURL

curl -X GET https://{{workspace}}.myeshopbox.com/api/v1/contacts\    
 -H "Authorization: Bearer XXXX"