Assets API
GET/api/v1/assets/export
Product availabilityAlgaPSA

Export assets

Exports all assets for the authenticated tenant (paginated internally, not capped to the default list page). Optional set filters asset_types, statuses, and client_ids narrow the result; fields restricts the exported columns. format=csv (default) returns text/csv with Content-Disposition attachment filename=assets.csv; format=json returns the success envelope with the rows in data. The route is authenticated and tenant-scoped via withApiKeyRouteAuth.

RBAC · asset

Query parameters

formatstringOptional
Export format. csv (default) returns text/csv as an attachment; json returns the success envelope with the rows in data.
asset_typesarray of stringOptional
Filter to these asset types. Repeat the param or pass a comma-separated list.
statusesarray of stringOptional
Filter to these asset statuses. Repeat the param or pass a comma-separated list.
client_idsarray of stringOptional
Filter to these client UUIDs. Repeat the param or pass a comma-separated list.
fieldsarray of stringOptional
Restrict exported columns to this set. Repeat the param or pass a comma-separated list.

Response body

Success response 200 · schema AssetExportJsonResponse

successbooleanRequired
Enum: true
dataobjectRequired
dataarray of AssetResourceRequired
All asset rows returned by AssetService.list with default list options. Export filters are currently not applied.
itemsobject
asset_idstring <uuid>Required
Primary key from assets.asset_id.
client_idstring <uuid>Required
Client UUID from assets.client_id.
asset_typestringRequired
Asset type stored in assets.asset_type.
asset_tagstringRequired
Tenant-specific asset tag.
namestringRequired
Asset display name.
statusstringRequired
Asset status.
location_idstring <uuid>Nullable
Client_locations.location_id link, when set.
locationstringNullable
Asset location, when recorded.
serial_numberstringNullable
Asset serial number, when recorded.
purchase_datestringNullable
Asset purchase date from assets.purchase_date.
warranty_end_datestringNullable
Warranty end date from assets.warranty_end_date.
created_atstring <date-time>Required
Asset creation timestamp.
updated_atstring <date-time>Required
Asset last update timestamp.
tenantstring <uuid>Required
Tenant UUID from assets.tenant; filtered to the authenticated request context.
client_namestring
Client name selected from the joined clients table.
warranty_statusstring
Computed from warranty_end_date by SQL CASE expression.
Enum: no_warrantyexpiredexpiring_soonactive
maintenance_statusstring
Optional computed maintenance status when present in service results.
extension_dataobject
relationshipsarray of object
Related asset rows included by getWithDetails after create.
itemsobject
documentsarray of object
Associated document rows included by getWithDetails after create.
itemsobject
maintenance_schedulesarray of object
Maintenance schedule rows included by getWithDetails after create.
itemsobject
_linksobject
HATEOAS links generated from the asset_id.
metaobjectRequired
timestampstring <date-time>Required
Response timestamp generated by createApiResponse/createErrorResponse.
versionstringRequired
API response version string.

Response codes

200
Asset export returned successfully. For format=csv (or omitted) the handler returns text/csv with an attachment filename; for format=json it returns this JSON envelope.
400
Query parameter validation failed.
401
x-api-key is missing/invalid.
403
Caller lacks asset:read.
500
Unexpected error.