Skip to main content
GET
Get Asset

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

assetId
string
required

assetId

Pattern: ^asset(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

simulatedAt
string<date-time>

Optional: the simulatedAt datetime

branchId
string

Optional: the branchId

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Response

type
string
required

Entity type

id
string
required

assetId

Pattern: ^asset(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
lastModifiedAt
string<date-time>
required

Last modified date of the asset

createdAt
string<date-time>
required

Creation date of the asset

status
enum<string>
required

Status of the asset

Available options:
ASSET_CREATED,
ASSET_REMOVED,
ASSET_QUOTED,
ASSET_CONFIRMED,
ASSET_STARTED,
ASSET_STOPPED,
ASSET_CANCELLED
policyId
string
required

policyId of asset owner

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
customFields
object[]

custom fields per product

name
string

Optional: Name of the entity

createdOnBranch
boolean

Whether the asset was created on a branch

editedOnBranch
boolean

Whether the asset was edited on a branch

startedAt
string<date-time>

Date the asset starts

stoppedAt
string<date-time>

Date the asset stops

cancelledAt
string<date-time>

Date the asset was cancelled

originAssetId
string

Id of the asset this asset replaces, if any

Pattern: ^asset(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
externalAssetId
string

externalAssetId

quote
object

asset quote

proratedQuote
object

Prorated asset quote based on the invoicing frequency of the policy