Retrieve a list of contact lists

get

/api/bulk/2.0/contacts/lists

Retrieves a list of contact lists.

Request

Supported Media Types
Query Parameters
  • A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.
  • Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.
  • Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.
  • A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".
  • Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ContactListSearchResponse
Type: object
Title: ContactListSearchResponse
The response body contains information about the contact list definitions.
Show Source
Nested Schema : items
Type: array
Title: items
The collection of items that match the search.
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve 2 contact lists:


GET /contacts/lists?limit=2&offset=10
			

Response:


{
    "items":[
        {
            "name":"IP Warming - Contacts Bounced Back",
            "count":0,
            "statement":"{{ContactList[54]}}",
            "uri":"/contacts/lists/54",
            "createdBy":"Deploy.User",
            "createdAt":"2011-05-27T15:30:17.4000000Z",
            "updatedBy":"Deploy.User",
            "updatedAt":"2011-05-27T15:30:17.4000000Z"
        },
        {
            "name":"SYSTEM - CRM Converted Leads",
            "count":0,
            "statement":"{{ContactList[50]}}",
            "uri":"/contacts/lists/50",
            "createdBy":"Deploy.User",
            "createdAt":"2011-05-27T15:14:34.8030000Z",
            "updatedBy":"Deploy.User",
            "updatedAt":"2011-05-27T15:14:34.8030000Z"
        }
    ],
    "totalResults":27,
    "limit":2,
    "offset":10,
    "count":2,
    "hasMore":true
}
			
Back to Top