Contacts: Export

The export sub-service allows a set of all contacts under control of the current account to be exported based on the time the resources were last modified.
  1. Supported Roles
  2. Available Services
    1. Full export
    2. Export Own Contacts
  3. Contact Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX No No
VOW No No
Private Yes No
More information about roles may be found here.

Available Services

Full export

URI: /<API Version>/contacts/export/all

HTTP Method Description Notes
GET Returns a list of all contacts belonging to the current user, and all users under the current user's control
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
Parameter Required
Standard search and paging syntax false

GET Response

{
    "D": {
        "Success": true,
        "ExportTimestamp": 2012-02-17T13:47:23
        "Results": [
            {
                "ResourceUri": "/vX/contacts/201010122342756895000000",
                "Id": "201010122342756895000000",
                "OwnerId": "201010943697015434000000",
                "DisplayName": "Some Person",
                "PrimaryEmail": "test@test.com",
                "Tags": [
                    "IDX Lead"
                ]
            },
            {
                "ResourceUri": "/vX/contacts/201010122342756234000000",
                "Id": "201010122342756234000000",
                "OwnerId": "201010123059764234000000",
                "DisplayName": "Another Person",
                "PrimaryEmail": "tester@testing.com",
                "Tags": [
                    "Recent Buyers"
                ]
            },
            
        ]
    }
}

Export Own Contacts

URI: /<API Version>/contacts/export

HTTP Method Description Notes
GET Returns a list of all contacts belonging to the current user
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
Parameter Required Notes
Standard search and paging syntax false  
_limit false The _limit parameter in this instance can bypass the maximum of 25 and be increased to 100

GET Response

{
    "D": {
        "Success": true,
        "ExportTimestamp": 2012-02-17T13:47:23
        "Results": [
            {
                "ResourceUri": "/vX/contacts/201010122342756895000000",
                "Id": "201010122342756895000000",
                "DisplayName": "Some Person",
                "PrimaryEmail": "test@test.com",
                "Tags": [
                    "IDX Lead"
                ]
            },
            {
                "ResourceUri": "/vX/contacts/201010122342756234000000",
                "Id": "201010122342756234000000",
                "DisplayName": "Another Person",
                "PrimaryEmail": "tester@testing.com",
                "Tags": [
                    "Recent Buyers"
                ]
            },
            
        ]
    }
}

Contact Description

See the response description for the Contacts service.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.