GET
/
contacts
/
v1
/
lists
Get all contact lists
curl --request GET \
  --url https://api.hubapi.com/contacts/v1/lists
{
  "lists": [
    {
      "listId": 123,
      "name": "<string>",
      "dynamic": true,
      "listType": "STATIC",
      "portalId": 123,
      "createdAt": 123,
      "updatedAt": 123,
      "internalListId": 123,
      "deleteable": true,
      "metaData": {
        "processing": "<string>",
        "size": 123,
        "error": "<string>",
        "lastProcessingStateChangeAt": 123,
        "lastSizeChangeAt": 123
      },
      "filters": [
        [
          {}
        ]
      ]
    }
  ],
  "offset": 123,
  "has-more": true
}

Query Parameters

​
count
integer
default:20

An integer representing the number of lists you want returned to your call. If the parameter isn't included, it defaults to 20. The maximum accepted value is 250; higher values will be accepted, but you will only get 250 records.

Required range: x <= 250
​
offset
integer

Used to page through the results. Each request will include a "has-more" field in the response JSON, which lets you know if there are more lists that you can pull. If "has-more" is true, you can use the returned offset parameter in the next request to get the next set of results.

Response

200 - application/json

Successful response with list of contact lists

The response is of type object.