Skip to content

Check List Integrity

POST
/lists/{list_id}/integrity-check

How complete the list’s data is: per field, how many contacts have a usable value.

Covers the default contact fields (email, phone, name, company, …) plus any extra_fields named. Reads only; nothing is written or enriched.

Authorizations

Parameters

Path Parameters

list_id
required

List (audience) id.

integer
>= 1

List (audience) id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Which fields to measure. Mirrors the app’s IntegrityCheckRequest.

object
extra_fields
Any of:
Array<string>

Responses

200

Successful Response

object
data
required

An open envelope around one sequencer record.

Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string