lists

Search Lists

Search for and return details about the lists in your organization. Private lists will not be returned with this call.

get/api/v1.4/lists/

Query parameters

namestring

Example:List A

List name

pageinteger

Example:2

The page of results to be returned

Response

countinteger required

Number of lists in the results.

pageinteger required

Current page of results.

pagesinteger required

Number of pages of results.

Example response

{
  "results": [
    {
      "name": "List A",
      "list_uid": "QE5XDQEB",
      "created_date": "2024-05-13T16:25:17.065916Z",
      "updated_date": "2024-06-17T07:15:59.708119Z",
      "company_count": 3
    }
  ],
  "count": 2,
  "page": 1,
  "pages": 1
}

Changes

Changed in 3 of the 5 revisions of this API.1216

Dec 4, 2024b36e8e329afb14See the full diff
- ○
  the endpoint scheme security ApiKeyAuth was removed from the API
  api-security-removed
- ○
  api tag lists added
  api-tag-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the media type application/json for the response with the status 429
  response-media-type-added
- ○
  added the media type application/json for the response with the status 500
  response-media-type-added
- ○
  the response property count became required for the status 200
  response-property-became-required
- ○
  the response property page became required for the status 200
  response-property-became-required
- ○
  the response property pages became required for the status 200
  response-property-became-required
- ○
  the response property results became required for the status 200
  response-property-became-required
- ○
  the response property results/items/company_count became required for the status 200
  response-property-became-required
- ○
  the response property results/items/created_date became required for the status 200
  response-property-became-required
- ○
  the response property results/items/list_uid became required for the status 200
  response-property-became-required
- ○
  the response property results/items/name became required for the status 200
  response-property-became-required
- ○
  the response property results/items/updated_date became required for the status 200
  response-property-became-required
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 4, 2024f80fb2a115ff112See the full diff
- ▲
  for the query request parameter page, the type/format was changed from string/ to integer/
  request-parameter-type-changed
- ●
  deleted the header request parameter Content-Type
  request-parameter-removed
- ○
  api operation id search removed and replaced with searchLists
  api-operation-id-removed
- ○
  the endpoint scheme security ApiKeyAuth was added to the API
  api-security-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 4, 202429fbf7a6e1061See the full diff
- ●
  deleted the header request parameter Authorization
  request-parameter-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history