TJtjc-lp
lists

Search Lists

Changed on

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/

Request

  • Base URL
    https://search.grata.com
  • Auth
    API key in header Authorization

Query parameters

namestring
Example:List A

List name

pageinteger
Example:2

The page of results to be returned

Response

OK

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

  • b36e8e329afbRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was removed from the API

    • info

      api tag lists added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

  • f80fb2a115ffRevision changes
    • breaking

      for the query request parameter page, the type changed from string to integer

    • warning

      deleted the header request parameter Content-Type

    • info

      api operation id search removed and replaced with searchLists

    • info

      the endpoint scheme security ApiKeyAuth was added to the API