Skip to content

Get Entity Template

GET
/v1/templates/{id}
curl --request GET \
--url https://example.com/api/v1/templates/example \
--header 'Authorization: <Authorization>'
id
required
string

Template ID

OK

Media type application/json
object
createdAt
string
defaultDescription
string
defaultInsured
boolean
defaultLifetimeWarranty
boolean
defaultLocation

Default location and tags

object
id
string
name
string
defaultManufacturer
string
defaultModelNumber
string
defaultName
string
defaultQuantity

Default values for entities

number
defaultTags
Array<object>
object
id
string
name
string
defaultWarrantyDetails
string
description
string
fields

Custom fields

Array<object>
object
booleanValue
boolean
id
string
name
string
numberValue
integer
textValue
string
timeValue
string
type
string
id
string
includePurchaseFields
boolean
includeSoldFields
boolean
includeWarrantyFields

Metadata flags

boolean
name
string
notes
string
updatedAt
string
Example generated
{
"createdAt": "example",
"defaultDescription": "example",
"defaultInsured": true,
"defaultLifetimeWarranty": true,
"defaultLocation": {
"id": "example",
"name": "example"
},
"defaultManufacturer": "example",
"defaultModelNumber": "example",
"defaultName": "example",
"defaultQuantity": 1,
"defaultTags": [
{
"id": "example",
"name": "example"
}
],
"defaultWarrantyDetails": "example",
"description": "example",
"fields": [
{
"booleanValue": true,
"id": "example",
"name": "example",
"numberValue": 1,
"textValue": "example",
"timeValue": "example",
"type": "example"
}
],
"id": "example",
"includePurchaseFields": true,
"includeSoldFields": true,
"includeWarrantyFields": true,
"name": "example",
"notes": "example",
"updatedAt": "example"
}