Get List Usage
GET /lists/{audience_id}/usage
GET
/lists/{audience_id}/usage
Count the live campaigns, sequences, newsletters and master lists that use this list.
Call it before deleting a list so you can state the real blast radius. Read-only. The list must be visible to the key (404 otherwise).
Authorizations
Parameters
Path Parameters
audience_id
required
List (audience) id.
integer
List (audience) id.
Header Parameters
Responses
200
Successful Response
object
data
required
An open envelope for one record, one dashboard or one job receipt.
Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.
object
key
additional properties
any
pagination
Any of:
object
has_next
required
Whether there are more pages
boolean
limit
required
Items per page
integer
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string