This is intended to help conceptualize requests.

We recommend tools such as Postman or ApiDog for development and testing.

Advanced
Parameter Description TypeScript Value
token (Required) Your API Token string
pretty (Optional) true means the response json will include white space for readability. Default is false. boolean
equipmentType_id (Required) The equipment type id of the equipment to search for string
service_type (Optional) Whether to include equipment which are out of service. By default, only in-service items will be fetched. in only fetches in-service items. out only fetches out-of-service items. all fetches both types. string
columns (Optional) The column names that should be fetched. If no columns are provided then all columns will be returned. string[]
include_null_metavalues (Optional) By default, empty metavalues will not appear in the output for a given equipment. When `true` empty metafield ids will be included with a `NULL` value. boolean