Skip to content
digizeDocs

List a list's records

GET
/api/v1/leads/lists/{id}/records
curl --request GET \
  --url 'https://digize.com/api/v1/leads/lists/example/records?offset=0&limit=1000' \
  --header 'x-api-key: <x-api-key>'

A page of a LeadsPlease list’s records, the newest first, and how many it has.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 64 characters

Query Parameters

Section titled “Query Parameters”
offset
integer
0 <= 9007199254740991
limit
integer
default: 1000 >= 1 <= 5000

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
name
required
string
company
required
string | null
title
required
string | null
industry
required
string | null
street
required
string
city
required
string
state
required
string
zip
required
string
phone
required
string | null
email
required
string | null
movedAt
required
Any of:
string format: date-time
homeValue
required

In cents.

number | null
returned
required
boolean
contactId
required
string | null
addedAt
required
string format: date-time
total
required
number

Example generated

{
  "data": [
    {
      "id": "example",
      "name": "example",
      "company": "example",
      "title": "example",
      "industry": "example",
      "street": "example",
      "city": "example",
      "state": "example",
      "zip": "example",
      "phone": "example",
      "email": "example",
      "movedAt": "2026-04-15T12:00:00Z",
      "homeValue": 1,
      "returned": true,
      "contactId": "example",
      "addedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "total": 1
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}