Docs
/
/
Contact supportLog inGet started
Overview
Client libraries
OpenAPI
Authentication
Errors
Postman
Overview
List assets
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Agents
Tutorials

Assets mAPI reference

Complete reference documentation for the Assets resource.

Assets

#

Assets are files you upload to Knock for use in your notification templates. Assets are account-wide and are not scoped to an environment.

Endpoints

GET/v1/assets

List assets

#

Returns a paginated list of active account assets. Assets are account-wide and do not require an environment parameter.

Endpoint

GET/v1/assets

Query parameters

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

limit
integer

The number of entries to fetch per-page.

Returns

PaginatedAssetResponse

A paginated list of Asset. Contains a list of entries and page information.

entries
Asset[]

A list of entries.

asset_type
string
Required

The type of asset.

created_at
string(date-time)
Required

The timestamp of when this asset was created.

filename
string

The human-readable filename for this asset.

id
string(uuid)
Required

The unique ID for this asset.

mime_type
string
Required

The MIME type for this asset.

updated_at
string(date-time)
Required

The timestamp of when this asset was last updated.

url
string
Required

The public URL for this asset.

page_info
PageInfo

The information about a paginated result.

after
string

The cursor to fetch entries after. Will only be present if there are more entries to fetch.

before
string

The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.

page_size
integer

The number of entries to fetch per-page.

Asset

#

An uploaded asset file for an account.

Attributes

asset_type
string

The type of asset.

created_at
string(date-time)

The timestamp of when this asset was created.

filename
string

The human-readable filename for this asset.

id
string(uuid)

The unique ID for this asset.

mime_type
string

The MIME type for this asset.

updated_at
string(date-time)

The timestamp of when this asset was last updated.

url
string

The public URL for this asset.

New chat