Get Contact List Details

This endpoint retrieves the details of a specific list identified by the list_id.

---

Using the SDK

// Download the helper library from https://www.npmjs.com/package/dropcowboy
const { DropCowboy } = require("dropcowboy"); // Or, for ESM: import { DropCowboy } from "dropcowboy";

// Find your Team ID and Secret at dropcowboy.com/appv1/#/api
// and set the environment variables.
const teamId = process.env.DROPCOWBOY_TEAM_ID;
const secret = process.env.DROPCOWBOY_SECRET;
const client = new DropCowboy({ teamId: teamId, secret: secret });

async function getList(listId) {
      const list = await client.getContactList(listId);

      console.log(list);
};

getList("00000000-0000-0000-0000-000000000000");

---

API Endpoint

GET

https://api.dropcowboy.com/v1/list/{list_id}

---

Example Request

Required Headers

• x-team-id - Your Team ID from API settings

• x-secret - Your Secret Key from API settings

Required URL Path Parameters

• list_id (string) - This endpoint retrieves the details of a specific list identified by the list_id. This parameter is required.

Get contact list details

get

Authorizations

teamSecretAuth

x-team-id / x-secretstringRequired

Requires two headers: x-team-id and x-secret. Both must be sent with each request.

Path parameters

list_idstringRequired

Responses

200

List details including contact_count.

application/json

list_idstringOptional

The UUID of the list. Use this value in other calls to the contact list api endpoints. It is safe to cache this value client side in your app.

list_namestringOptional

A string containing the name of the list.

created_atintegerOptional

Milliseconds since epoch of when the list was created.

contact_countintegerOptional

The total number of contacts in the list.

get

/list/{list_id}

HTTPcURLJavaScriptPython

GET /v1/list/{list_id} HTTP/1.1
Host: api.dropcowboy.com
x-team-id / x-secret: YOUR_API_KEY
Accept: */*

200

List details including contact_count.

{
  "list_id": "text",
  "list_name": "text",
  "created_at": 1,
  "contact_count": 1
}

---

Example Response

On successful retrieval, the response will contain the following structure:

• list_id (string): The UUID of the list. Use this value in other calls to the contact list API endpoints. It is safe to cache this value client side in your app.

• list_name (string): A string containing the name of the list.

• created_at (integer): Milliseconds since epoch of when the list was created.

• contact_count (integer): The total number of contacts in the list.