Assets

Company property and who holds it. An asset is retired rather than deleted, so pass include_deleted if you are mirroring this — without it a retirement looks like a record that simply stopped existing.

List asset categories

GET/v1/asset_categories

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
is_active	boolean	No	Filter by whether the record is in use.

Responses

Status	Meaning
200	A page of asset categories.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve an asset category

GET/v1/asset_categories/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The asset category.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such asset category in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.

List assets

GET/v1/assets

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
category_id	string	No	Only assets in this category.
status	string	No	Only assets in this state.
condition	string	No	Only assets in this condition.
asset_tag	string	No	Look up one asset by the workspace's own tag.
include_deleted	boolean	No	Include retired assets, flagged deleted: true. Required for a client syncing on updated_since to observe a retirement at all.

Responses

Status	Meaning
200	A page of assets.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve an asset

GET/v1/assets/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The asset.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such asset in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.

List asset assignments

GET/v1/asset_assignments

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
employee_id	string	No	Only records for this employee.
asset_id	string	No	Only assignments of this asset.
status	string	No	Only assignments in this state.

Responses

Status	Meaning
200	A page of asset assignments.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve an asset assignment

GET/v1/asset_assignments/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The asset assignment.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such asset assignment in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.