Skip to content

List Assets

Retrieve a paginated list of all assets in your store.

Last updated

  • q (string, query)

    Search by asset name or filename. Performs a partial, case-insensitive match.

  • type (string, query)

    Filter by asset type. Accepts: external, licence.

  • page (integer, query, default 1)

    Page number for pagination.

  • per_page (integer, query, default 25)

    Number of assets per page. Minimum: 1, maximum: 250.

  • assets (array, required)

    List of asset objects.

    Asset properties:

    • id (string, required)

      Unique asset identifier (UUID).

    • type (string, required)

      The asset type: internal, external, or licence.

    • name (string | null)

      Display name of the asset.

    • filename (string | null)

      Filename derived from the uploaded file or URL.

    • external_url (string | null)

      The external URL for external type assets. null for other types.

    • content_type (string | null)

      MIME type of the asset.

    • byte_size (integer, required)

      File size in bytes. 0 for external and licence assets.

    • watermark_asset (boolean, required)

      Whether watermarking is enabled for this asset.

    • autogenerate_licence_key (boolean, required)

      Whether a licence key is auto-generated on purchase.

    • created_at (string, required)

      ISO 8601 timestamp of when the asset was created.

    • updated_at (string, required)

      ISO 8601 timestamp of when the asset was last updated.

  • pagination (object, required)

    Pagination metadata.

    Pagination properties:

    • current_page (integer, required)

      Current page number.

    • per_page (integer, required)

      Number of items per page.

    • total_count (integer, required)

      Total number of assets matching the filters.

    • total_pages (integer, required)

      Total number of pages.

Example request

Terminal window
curl -X GET 'https://app.filemonk.io/api/v1/external/assets?type=external&per_page=10' \
-H 'X-Auth-Token: fm_api_key_your_key_here'
const response = await fetch(
'https://app.filemonk.io/api/v1/external/assets?type=external&per_page=10',
{ headers: { 'X-Auth-Token': 'fm_api_key_your_key_here' } }
);
const data = await response.json();
response = requests.get(
'https://app.filemonk.io/api/v1/external/assets',
headers={'X-Auth-Token': 'fm_api_key_your_key_here'},
params={'type': 'external', 'per_page': 10}
)
data = response.json()

Example response

{
"assets": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "external",
"name": "Photoshop Brushes Pack",
"filename": "brushes-pack-v2.zip",
"external_url": "https://cdn.example.com/files/brushes-pack-v2.zip",
"content_type": "application/zip",
"byte_size": 0,
"watermark_asset": false,
"autogenerate_licence_key": false,
"created_at": "2026-03-01T14:30:00Z",
"updated_at": "2026-03-01T14:30:00Z"
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"type": "licence",
"name": "Licence Key (Autogenerated)",
"filename": "Licence Key",
"external_url": null,
"content_type": "licence/key",
"byte_size": 0,
"watermark_asset": false,
"autogenerate_licence_key": true,
"created_at": "2026-03-02T09:00:00Z",
"updated_at": "2026-03-02T09:00:00Z"
}
],
"pagination": {
"current_page": 1,
"per_page": 10,
"total_count": 24,
"total_pages": 3
}
}
{
"error": "Invalid API key"
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support