Skip to main content
GET
List Assets

Authorizations

api_key
string
header
required

Query Parameters

limit
integer
default:20

Max assets to return, 1–100. e.g. 20

Required range: 1 <= x <= 100
offset
integer | null
default:0

How many assets to skip, for pagination. e.g. 0

Required range: x >= 0
status
enum<string>

Filter by lifecycle status; omit for all. One of: published, unpublished. e.g. 'published'

Available options:
published,
unpublished
privacy
enum<string>

Filter by privacy; omit for all. One of: only_me, workspace, public. e.g. 'public'

Available options:
only_me,
workspace,
public
category

Filter by what the deliverable is; omit for all. One of: battle-card, one-pager, deck, microsite, account-plan, magazine, emails, proposal, report, brief, voice-quotes, brand-kit, other — or none for assets never categorized. e.g. 'battle-card'

Available options:
battle-card,
one-pager,
deck,
microsite,
account-plan,
magazine,
emails,
proposal,
report,
brief,
voice-quotes,
brand-kit,
other
opportunityOId

Only the assets made for this CRM opportunity (every deliverable Deal Pulse built for the deal), or none for assets not tied to any deal; omit for all. e.g. 'op_2k9f…'

Pattern: ^[A-Za-z0-9_-]{1,64}$
accountOId

Only the assets made for this CRM account, or none for assets not tied to any account; omit for all. e.g. 'ca_8h2d…'

Pattern: ^[A-Za-z0-9_-]{1,64}$
skillOId

Only the documents this workspace skill's runs made, any for every asset a skill made, or none for assets no skill made; omit for all. e.g. 'skl_4m1x…'

Pattern: ^[A-Za-z0-9_-]{1,64}$

Server-side case-insensitive substring match across identifier, description, and vanitySlug — use this to check whether something is already published before creating it. Applied before pagination, so total reflects matches. e.g. 'q3 deck'

Maximum string length: 255
ownerEmail
string<email>

Only assets owned by this workspace member (within what you can already see — never widens access). e.g. 'sam@acme.com'

Response

Assets listed successfully

_metadata
object
required
data
object[]
required
total
number
required
hasNext
boolean
required