Skip to content

AI Leads Engine

Lead lists

Tables of leads in the Leads Engine. A deleted list goes to Trash and can be restored for 90 days.

List lead lists

GET/api/v1/lists

Every list with its lead count.

Any API key, read-only included.

Errors

  • 401Missing or invalid key
  • 429More than 120 requests a minute
Request
curl https://app.zicreach.com/api/v1/lists \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "data": [
        {
            "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
            "name": "SaaS founders UK",
            "description": "From a people search",
            "leads": 412,
            "created_at": "2026-09-18T09:00:00Z"
        }
    ]
}

Create a list

POST/api/v1/lists

An empty list to add leads to.

Needs a read and write API key.

Body

NameTypeDescription
namerequired string List name.
description string What the list is for.

Errors

  • 401Missing or invalid key
  • 403Read-only key used for a change, or a key made by someone who is no longer an owner or admin
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl -X POST https://app.zicreach.com/api/v1/lists \
  -H "Authorization: Bearer zk_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"Q4 founders","description":"Imported from our CRM"}'
Response201
{
    "data": {
        "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
        "name": "SaaS founders UK",
        "description": "From a people search",
        "leads": 0,
        "created_at": "2026-09-18T09:00:00Z"
    }
}

Get a list

GET/api/v1/lists/{id}

One list.

Any API key, read-only included.

Parameters

NameTypeDescription
idrequired path uuid List id.

Errors

  • 401Missing or invalid key
  • 404Not found in this workspace
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl https://app.zicreach.com/api/v1/lists/9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10 \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "data": {
        "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
        "name": "SaaS founders UK",
        "description": "From a people search",
        "leads": 412,
        "created_at": "2026-09-18T09:00:00Z"
    }
}

Delete a list

DELETE/api/v1/lists/{id}

Moves the list to Trash.

Needs a read and write API key.

Parameters

NameTypeDescription
idrequired path uuid List id.

Errors

  • 401Missing or invalid key
  • 403Read-only key used for a change, or a key made by someone who is no longer an owner or admin
  • 404Not found in this workspace
  • 422Invalid input, or not ready; the body has message and an errors object, one entry per field
  • 429More than 120 requests a minute
Request
curl -X DELETE https://app.zicreach.com/api/v1/lists/9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10 \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "message": "List moved to Trash. It can be restored for 90 days."
}

List lead lists (short)

GET/api/v1/leads/lists

Id, name and lead count only.

Any API key, read-only included.

Errors

  • 401Missing or invalid key
  • 429More than 120 requests a minute
Request
curl https://app.zicreach.com/api/v1/leads/lists \
  -H "Authorization: Bearer zk_your_key"
Response200
{
    "data": [
        {
            "id": "9d1c6a2e-4b7f-4e0a-9a51-2f8c3b6d7e10",
            "name": "SaaS founders UK",
            "leads": 412
        }
    ]
}