v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Assets
Fields

Asset Fields

This request gets detailed information about asset fields such as Make, Model and any other custom field.

This call also returns "files" which is an array of objects that have a file name and a link you can use to download that file. All links are only valid for 15 minutes, a new call will generate a new link.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

get/v2/assets/fields

Query parameters

namestring

This parameter is used to only get specific field by name. This parameter expects a string full name of a field or partial name with the wildcard %.

fieldsinteger

This parameter can be used to get a single Asset Fields or a list of Asset Fields in a comma-separated list.

startinteger

This parameter is used to only get Asset Fields for Assets that were last edited after the unix timestamp passed into the start parameter. For example, all Assets that were last edited after April 18th, 2018.

endinteger

This parameter is used to only get Asset Fields for Assets that were last edited before the unix timestamp passed into the end parameter.

cursorinteger

This parameter is a cursor that selects what id you want to start receiving results at. e.g. passing 137 here will only get you asset fields with an id greater than 137.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time.

locationsinteger

This parameter can be used to get a group of asset fields in a location in a comma-separated list.

valuestring

This parameter is used to only get specific field by value. This parameter expects a string full name of a field or partial name with the wildcard %.

assetNamestring

This parameter is used to only get specific fields by asset name. This parameter expects a string full name of a field or partial name with the wildcard %.

fieldType[0]string

This parameter is used to only get specific fields by type. This parameter expects an array of strings "Text, Date, Pictures, Documents, Number, Currency, Dropdown"

fieldType[1]string

This parameter is used to only get specific fields by type. This parameter expects an array of strings "Text, Date, Pictures, Documents, Number, Currency, Dropdown"

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

valuesstring

This parameter is used to get asset fields by their valueID. This parameter expects a comma delimited list of Value IDs.

assetsinteger

This parameter can be used to get a group of asset fields for a specific set of asset ids in a comma-separated list.

Response

Asset Fields

fieldIDinteger
assetIDinteger
locationIDinteger
fieldstring
{"stackTrail":"paths:/v2/assets/fields:get:responses:200:content:application/json:schema:items:properties:value","oasType":"schema","type":"unknown"}
valueIDinteger
fieldTypestring
lastEditedinteger
lockedboolean