Get Lists

Retrieve metadata for all your lists.

INFO

Please note that due to the potential list sizes we are not returning the list content in API responses.

Authorization OAuth 2.0

This request requires OAuth 2.0 authorization.

Header Parameters

• • Authorization string required

    Bearer {ACCESS_TOKEN}

  • Content-Type string required

    application/json

  • Accept string required

    application/json

Response Parameters

• • current_page integer

    Current page of result set.

  • data array

    • object

      • id integer

        The ID of the list, can be used for future API requests to query list details or make updates.

      • name string

        The name of the list.

      • type string

        The type of list, one of: Affiliates Bank Routing Numbers Email Addresses Employer Names Telephone Numbers Social Security Numbers Last Four of Social Security Numbers ZIP Codes

      • created_at datetime

        Timestamp of when the list was created.

      • deleted_at datetime

        Timestamp of when the list was archived, null if not archived.

      • updated_at datetime

        Timestamp of when the list was last updated.

  • first_page_url string

    Link to first page, used for programatically traversing the resultset.

  • from integer

    Index of total result items for the first item on the current page of the results.

  • last_page integer

    Number of pages for result set.

  • last_page_url string

    Link to last page, used for programatically traversing the resultset.

  • links array

    Link to last page, used for programatically traversing the resultset.

    • object

      • url string

        Link to pagination page, used for programatically traversing the resultset.

      • label string

        Previous, Next, or page number, used for programatically traversing the resultset.

      • active boolean

        Indicates if the object represents the current page.

  • next_page_url string

    Link to next page, used for programatically traversing the resultset.

  • path string

    Link used for making the request.

  • per_page string

    Number of items returned per paginated request.

  • prev_page_url string

    Link to previous page, used for programatically traversing the resultset.

  • to integer

    Index of total result items for the last item on the current page of the results.

  • total integer

    Total number of items available in the resultset.

GET /api/v1/lead-management/lists

cURL

curl --request POST \
    "https://api.decisioncloud.me/api/v1/list-manager/lists" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

JavaScript

const url = new URL(
    "https://api.decisioncloud.me/api/v1/list-manager/lists"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

PHP

$client = new \GuzzleHttp\Client();
$response = $client->get(
    "https://api.decisioncloud.me/api/v1/list-manager/lists",
    [
        "headers" => [
            "Authorization" => "Bearer {ACCESS_TOKEN}",
            "Content-Type" => "application/json",
            "Accept" => "application/json",
        ],
    ],
);
$body = $response->getJson();
print_r($body);

Python

import requests
import json

url = "https://api.decisioncloud.me/api/v1/list-manager/lists"

headers = {
  "Authorization": "Bearer {ACCESS_TOKEN}",
  "Content-Type": "application/json",
  "Accept": "application/json"
}

response = requests.request("GET", url, headers=headers)
response.json()

200

{
    "current_page": 1,
    "data": [
        {
            "id": 11,
            "name": "SSN List 1",
            "type": "Social Security Numbers",
            "deleted_at": null,
            "created_at": "2025-05-02T19:28:55.000000Z",
            "updated_at": "2025-05-02T22:01:12.000000Z"
        }
    ],
    "first_page_url": "http:\/\/app.decisioncloud.local\/api\/v1\/list-manager\/lists?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http:\/\/app.decisioncloud.me\/api\/v1\/list-manager\/lists?page=1",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "http:\/\/app.decisioncloud.me\/api\/v1\/list-manager\/lists?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "http:\/\/app.decisioncloud.me\/api\/v1\/list-manager\/lists",
    "per_page": 250,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}