Lookup assets by a field

post

https://api.safetyculture.io/assets/v1/assets:LookupAssetsByField

Use this endpoint to search assets by a specific field value (for example, VIN or fleet ID) rather than by the unique asset ID.

Choose which asset field you want to use.
Provide a value that must match that field on one or more assets.
The service returns any assets where that field matches the value you sent.

This endpoint currently only supports asset fields that store string values.
For broader queries across multiple filters, use List assets endpoint instead.

Requirements

📘
If your organization uses site-based access for assets, the API only returns assets that the API token’s user can access through their site membership.

Body Params

The parameters for LookupAssetsByField

page_token

string

OPTIONAL. The value of next_page_token from a previous response. If
specified, the API will return the next batch of results following the
previous list assets request.

page_size

int32

OPTIONAL. The number of assets to return. By default, each request
returns 50 assets. You can specify a page_size value between 1 to 100.

asset_filters

array of objects

OPTIONAL. The array of asset filters to apply in your request. You can
apply multiple filters in a single request.

asset_filters

order_by

object

Describes the sorting options for the list assets endpoint. By default,
assets are sorted by creation date from the most recent to the least recent.

field_name

string

required

REQUIRED. The name of the asset field to match.

string_value

string

REQUIRED. The string value of the asset field to match.

Responses

Requirements

200A successful response.

defaultAn unexpected error response.