Retrieve collection of contacts

get

/services/rest/connect/v1.4/contacts

Request

Supported Media Types
Query Parameters
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name
  • The requested page size, which limits the number of elements the collection should max return
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Returns the count of elements as the given order. The value is a comma delimited string. Each token in the string is the name of the field, optionally followed by asc or desc.
  • Query parameter that allows searching by providing ROQL WHERE clause filtering
  • Indicates whether or not to calculate the totalResults property. By default, totalResults is not calculated.

Response

Supported Media Types

Default Response

Body ()
Collection of contacts
Root Schema : contacts-collection
Type: object
Collection of contacts
Show Source

Examples

Use GET with the following syntax to list all contacts:

https://your_site_interface/services/rest/connect/version/contacts

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/contacts

Response body example

{
    "items": [
        {
            "id": 2,
            "lookupName": "Susan Meadows",
            "createdTime": "2013-08-21T20:30:18Z",
            "updatedTime": "2013-08-21T21:02:09Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/2"
                }
            ]
        },
        {
            "id": 3,
            "lookupName": "George Langston",
            "createdTime": "2013-08-21T20:31:10Z",
            "updatedTime": "2013-08-21T21:04:22Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/3"
                }
            ]
        },

        ...

        {
            "id": 82,
            "lookupName": "Calvin Hobbes",
            "createdTime": "2015-09-29T20:15:35Z",
            "updatedTime": "2015-09-29T20:15:35Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/82"
                }
            ]
        }
    ],
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contacts",
            "mediaType": "application/schema+json"
        },
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts"
        }
    ]
}