Lists

Get List 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).

get/lists/{audience_id}/usage

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/lists/{audience_id}/usage
  • Auth: HTTP bearer

Path parameters

audience_idinteger required

List (audience) id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataCrmRecordPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.