AssetTiger API Documentation: This page provides a structured and interactive overview of all available API endpoints. Use the navigation menu on the left to explore endpoints, and view detailed request and response information on the right.
v1. Ensure you are using the correct API version for compatibility and feature support.v1), while Sandbox endpoints are provided separately for testing without affecting live data. Always use the correct token for the corresponding environment./schemas page.This documentation is designed to help developers quickly understand, test, and integrate with the API by providing clear examples, structured schemas, and interactive tools.
API Credentials:
To access the API, you will need an API Token and an Auth Token.
These credentials can be generated and managed from your account settings.
You can create up to 5 active tokens per account, along with one sandbox token for testing purposes.
Both tokens must be used with the /authorize endpoint to generate an Access Token, which is required for all secured API requests.
Important:
• Keep your tokens secure and do not expose them publicly.
• Use sandbox tokens only with sandbox endpoints.
• Tokens can be regenerated anytime from your account settings.
• Each endpoint may return different status codes based on request validation and processing results.
Logs out the current user and invalidates their access token.
Production Endpoint:
https://api.assettiger.com/v1/logout
Sandbox Endpoint:
https://api.assettiger.com/sandbox/logout
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves the details of a aisle by its unique identifier (refId). including optional shelf and bin data if requested.
Production Endpoint:
https://api.assettiger.com/v1/aisles/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/aisles/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the aisle (positive integer only). |
fetchShelves |
boolean | No | No | - | Indicates whether to include shelves associated with this ailse (default: false). |
fetchBins |
boolean | No | No | - | Include bins associated with this aisle/shelves (default: false). Works only if fetchShelves is true. |
Responses:
Retrieves a list of aisles filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/aisles
Sandbox Endpoint:
https://api.assettiger.com/sandbox/aisles
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter aisles by name (Search keyword cannot exceed 100 characters.). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by aisle name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Schema: AisleListRequest
Responses:
Creates a aisle using the provided `name` in the request.
Production Endpoint:
https://api.assettiger.com/v1/aisles/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/aisles/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "USA"
}Schema: AddAisleRequest
Responses:
Modifies the aisle identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/aisles/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/aisles/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the aisle (positive integer only). |
Request Body:
{
"name": "USA"
}Schema: UpdateAisleRequest
Responses:
Deletes a aisle by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/aisles/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/aisles/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the aisle (positive integer only). |
Responses:
Retrieves a single asset event by the event's unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/events/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/events/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the event (positive integer only). |
Responses:
Retrieves the list of events associated with given asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset (positive integer only). |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Default: "DateCreated". Allowed values: DateCreated, StartDate, EndDate. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: EventListRequest
Responses:
Marks the specified asset as broken. Broken must be enabled in Setup Events, and the asset must not already be broken. When asset linking and broken linking are enabled, linked assets are marked broken too. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/broken/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/broken/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-09-18T15:20:00",
"notes": "Screen cracked after a fall in the warehouse."
}Schema: AddBrokenEventRequest
Responses:
Checks in the specified asset. The asset must be checked out, and check out must be enabled in Setup Events. Whether it is checked in from a person or a site/location follows its current check-out. siteRefId is required when it is checked out to a site/location; newSiteRefId and newLocationRefId apply when it is checked out to a person. When asset linking and check-out linking are enabled, linked assets are checked in too. Set sendEmail to send the check-in notification to the email address of the person the asset is checked out to. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/checkin/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/checkin/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-03-15T16:45:00",
"siteRefId": null,
"locationRefId": null,
"newSiteRefId": 1,
"newLocationRefId": 3,
"newDepartmentRefId": 2,
"notes": "Returned in good condition.",
"sendEmail": true
}Schema: AddCheckinEventRequest
Responses:
Checks out the specified asset to a person or to a site/location. Check out must be enabled in Setup Events. personRefId is required when checkoutTo is Person; siteRefId is required when it is SiteLocation. When asset linking and check-out linking are enabled, linked assets are checked out too. Set sendEmail to send the check-out notification to the person's email address. If the asset (or a linked asset, with check-out linking) is reserved by someone else for these dates, nothing is saved and 409 lists the reservations; set overrideReservation to true to check out anyway. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/checkout/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/checkout/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"checkoutTo": "Person",
"date1": "2026-03-01T09:30:00",
"date2": "2026-03-15T17:00:00",
"personRefId": 1,
"siteRefId": null,
"locationRefId": null,
"newSiteRefId": null,
"newLocationRefId": null,
"newDepartmentRefId": null,
"notes": "Checked out for field use.",
"sendEmail": true,
"overrideReservation": false
}Schema: AddCheckoutEventRequest
Responses:
Marks the specified asset as disposed. Dispose must be enabled in Setup Events, and the asset must not already be disposed. When asset linking and dispose linking are enabled, linked assets are marked disposed too. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/dispose/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/dispose/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-09-01T11:00:00",
"textField": "GreenCycle Electronics",
"notes": "End of life; data drive wiped before disposal."
}Schema: AddDisposeEventRequest
Responses:
Marks the specified asset as donated. Donate must be enabled in Setup Events, and the asset must not already be donated. When asset linking and donate linking are enabled, linked assets are marked donated too. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/donate/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/donate/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-08-03T13:00:00",
"textField": "City Library",
"currency": 300.0,
"boolean": true,
"notes": "Donated with power adapter and carry case."
}Schema: AddDonateEventRequest
Responses:
Marks the specified lost asset as found. The asset must be lost, and lost must be enabled in Setup Events. When asset linking and lost linking are enabled, linked assets are marked found too. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/found/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/found/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-05-20T11:15:00",
"notes": "Found in the storage closet on floor 2."
}Schema: AddFoundEventRequest
Responses:
Leases the specified asset to a customer. Lease must be enabled in Setup Events, and the asset must not already be leased. When asset linking and lease linking are enabled, linked assets are leased too. Set sendEmail to send the lease notification to the customer's email address. If the asset (or a linked asset, with lease linking) is reserved by someone else for these dates, nothing is saved and 409 lists the reservations; set overrideReservation to true to lease anyway. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/lease/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/lease/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"customerRefId": 3,
"date1": "2026-04-01T09:00:00",
"date2": "2026-09-30T17:00:00",
"notes": "Six-month lease for the trade show season.",
"sendEmail": true,
"overrideReservation": false
}Schema: AddLeaseEventRequest
Responses:
Returns the specified leased asset. The asset must be leased, and lease must be enabled in Setup Events. When asset linking and lease linking are enabled, linked assets are returned too. Set sendEmail to send the lease return notification to the email address of the customer the asset is leased to. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/leasereturn/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/leasereturn/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-09-30T16:00:00",
"notes": "Returned at the end of the lease, no damage.",
"sendEmail": true
}Schema: AddLeaseReturnEventRequest
Responses:
Marks the specified asset as lost. Lost must be enabled in Setup Events, and the asset must not already be lost. When asset linking and lost linking are enabled, linked assets are marked lost too. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/lost/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/lost/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-05-12T14:30:00",
"notes": "Last seen in conference room B."
}Schema: AddLostEventRequest
Responses:
Sends the specified asset for repair. Repair must be enabled in Setup Events. If the asset is already in repair, its open repair is updated with these details instead, set date2 (completed date) to finish it. Setting date2 (completed date) ends the repair: the asset goes back to its previous check-out or lease, or to Available. When asset linking and repair linking are enabled, linked assets are sent for repair too. Returns the repair event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/repair/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/repair/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-06-02T09:00:00",
"textField": "Nancy Griffin",
"date2": null,
"currency": 120.0,
"notes": "Screen flickers; sent to the service center."
}Schema: AddRepairEventRequest
Responses:
Marks the specified asset as sold. Sell must be enabled in Setup Events, and the asset must not already be sold. When asset linking and sell linking are enabled, linked assets are marked sold too. Returns the new event's refId.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/sell/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/sell/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"date1": "2026-07-15T10:00:00",
"textField": "Robert Bennett",
"currency": 450.0,
"notes": "Sold after the hardware refresh."
}Schema: AddSellEventRequest
Responses:
Updates a broken event on the specified asset. The event must belong to the asset and be a broken event.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/broken/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/broken/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the broken event. Must be a positive integer. |
Request Body:
{
"date1": "2026-09-18T15:20:00",
"notes": "Screen cracked after a fall in the warehouse; insurance claim filed."
}Schema: UpdateBrokenEventRequest
Responses:
Updates a check-in event on the specified asset. The event must belong to the asset and be a check-in event. siteRefId is required when checkinFrom is SiteLocation. No email is sent.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/checkin/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/checkin/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the check-in event. Must be a positive integer. |
Request Body:
{
"checkinFrom": "SiteLocation",
"date1": "2026-03-15T16:45:00",
"siteRefId": 1,
"locationRefId": 3,
"notes": "Returned to the main warehouse."
}Schema: UpdateCheckinEventRequest
Responses:
Updates a check-out event on the specified asset. The event must belong to the asset and be a check-out event. personRefId is required when checkoutTo is Person; siteRefId is required when it is SiteLocation. No email is sent.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/checkout/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/checkout/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the check-out event. Must be a positive integer. |
Request Body:
{
"checkoutTo": "SiteLocation",
"date1": "2026-03-01T09:30:00",
"date2": "2026-03-20T17:00:00",
"personRefId": null,
"siteRefId": 1,
"locationRefId": 3,
"notes": "Moved to the warehouse for the rest of the project."
}Schema: UpdateCheckoutEventRequest
Responses:
Updates a dispose event on the specified asset. The event must belong to the asset and be a dispose event.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/dispose/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/dispose/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the dispose event. Must be a positive integer. |
Request Body:
{
"date1": "2026-09-01T11:00:00",
"textField": "GreenCycle Electronics",
"notes": "End of life; data drive wiped and certificate received."
}Schema: UpdateDisposeEventRequest
Responses:
Updates a donate event on the specified asset. The event must belong to the asset and be a donate event.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/donate/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/donate/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the donate event. Must be a positive integer. |
Request Body:
{
"date1": "2026-08-03T13:00:00",
"textField": "City Library",
"currency": 275.0,
"boolean": true,
"notes": "Value corrected per receipt."
}Schema: UpdateDonateEventRequest
Responses:
Updates a found event on the specified asset. The event must belong to the asset and be a found event.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/found/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/found/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the found event. Must be a positive integer. |
Request Body:
{
"date1": "2026-05-19T16:00:00",
"notes": "Found in the storage closet on floor 2; returned to IT."
}Schema: UpdateFoundEventRequest
Responses:
Updates a lease event on the specified asset. The event must belong to the asset and be a lease event. No email is sent.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/lease/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/lease/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the lease event. Must be a positive integer. |
Request Body:
{
"customerRefId": 3,
"date1": "2026-04-01T09:00:00",
"date2": "2026-12-31T17:00:00",
"notes": "Lease extended to the end of the year."
}Schema: UpdateLeaseEventRequest
Responses:
Updates a lease return event on the specified asset. The event must belong to the asset and be a lease return event. No email is sent.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/leasereturn/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/leasereturn/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the lease return event. Must be a positive integer. |
Request Body:
{
"date1": "2026-10-01T10:00:00",
"notes": "Returned one day late; minor scratches noted."
}Schema: UpdateLeaseReturnEventRequest
Responses:
Updates a lost event on the specified asset. The event must belong to the asset and be a lost event.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/lost/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/lost/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the lost event. Must be a positive integer. |
Request Body:
{
"date1": "2026-05-11T17:00:00",
"notes": "Last seen in conference room B; reported to security."
}Schema: UpdateLostEventRequest
Responses:
Updates a repair event on the specified asset. The event must belong to the asset and be a repair event. Setting date2 (completed date) on the open repair ends it: the asset goes back to its previous check-out or lease, or to Available.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/repair/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/repair/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the repair event. Must be a positive integer. |
Request Body:
{
"date1": "2026-06-02T09:00:00",
"textField": "Nancy Griffin",
"date2": "2026-06-06T15:30:00",
"currency": 145.5,
"notes": "Screen replaced; repair complete."
}Schema: UpdateRepairEventRequest
Responses:
Updates a sell event on the specified asset. The event must belong to the asset and be a sell event.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/sell/{eventRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/sell/{eventRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the sell event. Must be a positive integer. |
Request Body:
{
"date1": "2026-07-15T10:00:00",
"textField": "Robert Bennett",
"currency": 425.0,
"notes": "Sold after the hardware refresh; price adjusted."
}Schema: UpdateSellEventRequest
Responses:
Deletes an event from the specified asset. The event must belong to the asset. The user needs permission to edit assets (or to add assets, for an asset they created) and that event's permission. A custom event needs custom event access in the user's group. Events can be deleted even if their type is now turned off in Setup Events. If the event is the asset's current event, the asset goes back to Available. Linked assets are not changed.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/{eventRefId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/{eventRefId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
eventRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the event. Must be a positive integer. |
Responses:
Undoes broken on the specified asset. The asset's current broken event is deleted and the asset goes back to Available. The asset must currently be broken, and broken must be enabled in Setup Events. When asset linking and broken linking are enabled, linked assets that are currently broken are restored too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/broken/undo
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/broken/undo
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Undoes dispose on the specified asset. The asset's current dispose event is deleted and the asset goes back to Available. The asset must currently be disposed, and dispose must be enabled in Setup Events. When asset linking and dispose linking are enabled, linked assets that are currently disposed are restored too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/dispose/undo
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/dispose/undo
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Undoes donate on the specified asset. The asset's current donate event is deleted and the asset goes back to Available. The asset must currently be donated, and donate must be enabled in Setup Events. When asset linking and donate linking are enabled, linked assets that are currently donated are restored too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/donate/undo
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/donate/undo
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Undoes sell on the specified asset. The asset's current sell event is deleted and the asset goes back to Available. The asset must currently be sold, and sell must be enabled in Setup Events. When asset linking and sell linking are enabled, linked assets that are currently sold are restored too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/events/sell/undo
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/events/sell/undo
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Retrieves a single asset reservation by the reservation's unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/reservations/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/reservations/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the reservation (positive integer only). |
Responses:
Returns the list of all reservation associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/reservations
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/reservations
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Reserves the specified asset for a person, a customer or a site/location. Person reservations need check-out and person reservations enabled in Setup Events; customer reservations need lease and customer reservations enabled. Returns 409 if the asset is already reserved for an overlapping period. When asset linking and reserve linking are enabled, linked assets are reserved too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/reservations/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/reservations/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"reserveTo": "Person",
"personRefId": 12,
"customerRefId": null,
"siteRefId": null,
"locationRefId": null,
"date1": "2026-11-02T09:00:00",
"date2": "2026-11-06T17:00:00",
"notes": "Reserved for the regional sales conference.",
"sendEmail": true,
"firstReminderEnabled": true,
"firstReminderLeadTimeDays": 2,
"secondReminderEnabled": false,
"secondReminderLeadTimeDays": 1
}Schema: AddReserveRequest
Responses:
Updates a reservation on the specified asset. The reservation must belong to the asset. Changing another user's reservation needs the Override Reservation permission. Returns 409 if the new dates overlap another reservation on the asset. When asset linking and reserve linking are enabled, the linked assets' matching reservations are updated too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/reservations/{reservationRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/reservations/{reservationRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
reservationRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the reservation. Must be a positive integer. |
Request Body:
{
"reserveTo": "Person",
"personRefId": 12,
"customerRefId": null,
"siteRefId": null,
"locationRefId": null,
"date1": "2026-11-03T09:00:00",
"date2": "2026-11-07T17:00:00",
"notes": "Conference moved by one day.",
"sendEmail": true,
"firstReminderEnabled": true,
"firstReminderLeadTimeDays": 2,
"secondReminderEnabled": true,
"secondReminderLeadTimeDays": 1
}Schema: UpdateReserveRequest
Responses:
Deletes a reservation from the specified asset. The reservation must belong to the asset. Deleting another user's reservation needs the Override Reservation permission. When asset linking and reserve linking are enabled, the linked assets' matching reservations are deleted too.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/reservations/{reservationRefId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/reservations/{reservationRefId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
reservationRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the reservation. Must be a positive integer. |
Responses:
Retrieves a single asset audit by the audit's unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/audits/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/audits/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit (positive integer only). |
fetchSiteName |
boolean | No | No | False | Indicates whether to include site name (default: false). |
fetchLocationName |
boolean | No | No | False | Indicates whether to include location name (default: false). |
Responses:
Returns the list of all audit associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/audits
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/audits
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
fetchSiteName |
boolean | No | No | False | Indicates whether to include site name (default: false). |
fetchLocationName |
boolean | No | No | False | Indicates whether to include location name (default: false). |
Responses:
Retrieves the details of a asset by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the asset (positive integer only). |
fetchCustomFields |
boolean | No | No | False | Indicates whether to include custom fields associated with this asset (default: false). |
fetchEvent |
boolean | No | No | False | Indicates whether to include current event associated with this asset (default: false). Also controls whether Status, EventRefId, and Event are populated in the response — all three are null when this is false, regardless of the asset's actual state. |
fetchReservation |
boolean | No | No | False | Indicates whether to include reservation associated with this asset (default: false). |
Responses:
Returns the list of unique identifiers of all contracts associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/contracts
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/contracts
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Retrieves the field configuration (enabled/disabled, required) for a single custom event by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/customeventsettings/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/customeventsettings/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the custom event (positive integer only). |
Responses:
Get Asset custom fields.
Production Endpoint:
https://api.assettiger.com/v1/assets/customfields
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/customfields
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves the list of documents linked to a given asset, including metadata such as file name, description, upload date, type.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/documents
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/documents
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset (positive integer only). |
Responses:
Returns the list of unique identifiers of all funds associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/funds
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/funds
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Retrieves the list of asset history by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/histories
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/histories
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
fromDate |
date | No | No | - | The start date for filtering asset history records. Returns records on or after this date. Format: "yyyy-MM-dd". Example: 2025-04-01. |
toDate |
date | No | No | - | The end date for filtering asset history records. Returns records on or before this date. Format: "yyyy-MM-dd". Example: 2025-04-30. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Desc" Allowed values: Asc, Desc. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: AssetHistoryListRequest
Responses:
Retrieves a single asset history record by the history's unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/histories/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/histories/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the history record (positive integer only). |
Responses:
Retrieves the list of images linked to a given asset metadata such as file name, upload date, and URL paths.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/images
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/images
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset (positive integer only). |
Responses:
Returns the list of unique identifiers of all insurances associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/insurances
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/insurances
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Returns the list of all maintenances associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/maintenances
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/maintenances
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
fetchCustomFields |
boolean | No | No | False | Indicates whether to include custom fields associated with this maintenance (default: false). |
Responses:
Get Asset Settings.
Production Endpoint:
https://api.assettiger.com/v1/assets/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Returns the list of all warranties associated with the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/warranties
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/warranties
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
fetchCustomFields |
boolean | No | No | False | Indicates whether to include custom fields associated with this warranty (default: false). |
Responses:
Retrieves list of assets filtered and sorted based on the provided query parameters. Supports searching by category, subcategory, site, location, department, person , customer, status, keywords, and various fields, with flexible sorting and pagination options.
Production Endpoint:
https://api.assettiger.com/v1/assets
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter assets by defined asset search fields. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | - | Asset fields that searchKeyword is matched against. Always provide at least one field (or searchCustomFields) when using searchKeyword; if neither is provided, searchKeyword is not applied. Allowed values: AssetTagId, Description, Brand, Model, SerialNo, PurchaseFrom. |
searchCustomFields |
[integer] | No | No | - | Defines which asset custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
categoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories. |
subCategoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories. |
siteRefId |
int32 | No | No | - | Unique identifier (primary key) of the site to filter by. Pass 0 to filter unassigned sites. |
locationRefId |
int32 | No | No | - | Unique identifier (primary key) of the location to filter by. If provided, siteRefId must also be specified. Pass 0 to filter unassigned locations. |
departmentRefId |
int32 | No | No | - | Unique identifier (primary key) of the department to filter by. Pass 0 to filter unassigned departments. |
personRefId |
int32 | No | No | - | Unique identifier (primary key) of the assigned person to filter by. |
customerRefId |
int32 | No | No | - | Unique identifier (primary key) of the assigned customer to filter by. |
EventTypes |
EventType(Enum) | No | Yes | - | Filters assets by the specified event types. Selecting "Custom" includes all user-defined custom events. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Allowed values: AssetTagId, Description, Brand, Model, SerialNo, PurchaseDate, PurchaseFrom, InitialCost, DateCreated, CreatedBy, CategoryName, SubCategoryName, SiteName, LocationName, DepartmentName, isDepreciable, SalvageValue, AssetLife, DepreciationMethodName, DateAcquired, Status, IsLinked, Relation, CurrentCost, PersonName, Notes, Cost, Reservation, EventDate1, EventDate2, LeaseTo. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc. |
startDate |
date | No | No | - | The start date for filtering asset records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering asset records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField is provided. Default: "DateCreated" Allowed values: DateCreated, PurchaseDate, DateAcquired. |
dateRangeByCustomField |
int32 | No | No | - | Defines which custom date field the filter should apply to. Provide the Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided. |
fetchCategoryName |
boolean | No | No | False | Whether to include category name in the result. Default: "false". |
fetchSubCategoryName |
boolean | No | No | False | Whether to include subcategory name in the result. Default: "false". |
fetchSiteName |
boolean | No | No | False | Whether to include site name in the result. Default: "false". |
fetchLocationName |
boolean | No | No | False | Whether to include location name in the result. Default: "false". |
fetchDepartmentName |
boolean | No | No | False | Whether to include department name in the result. Default: "false". |
fetchEvent |
boolean | No | No | False | Whether to include the current event associated with each asset in the response. Default: false. Also controls whether Status, EventRefId, and Event are populated on each returned asset — all three are null when this is false, regardless of the asset's actual state. |
fetchReservation |
boolean | No | No | False | Whether to include the current reservation associated with each asset in the response. Default: false. |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: "false". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: AssetListRequest
Responses:
Retrieves the details of a linked assets by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/linkedassets
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/linkedassets
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Creates a Asset using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/assets/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"assetTagId": "AST-000001",
"description": "Sample Dell Laptop",
"brand": "Dell",
"model": "Latitude 5420",
"serialNo": "SN-123456789",
"purchaseDate": "2025-01-01",
"purchaseFrom": "Example Vendor Inc.",
"cost": 1200.0,
"siteRefId": 1,
"locationRefId": 1,
"categoryRefId": 1,
"subCategoryRefId": 1,
"departmentRefId": 1,
"depreciationMethod": "StraightLine",
"dateAcquired": "2025-01-01",
"isDepreciable": true,
"initialCost": 1200.0,
"salvageValue": 100.0,
"assetLife": 36,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: AddAssetRequest
Responses:
Adds an audit record to the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/audits/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/audits/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"auditNameRefId": 1,
"siteRefId": 1,
"locationRefId": 3,
"notes": "Asset verified in expected location.",
"auditDate": "2026-03-01T09:30:00",
"updateAssetLocation": true,
"recordGps": true,
"latitude": 40.712776,
"longitude": -74.005974
}Schema: AddAuditRequest
Responses:
Sets a child for the specified asset, linking the two as a parent/child pair. The asset becoming the parent must not itself already have a parent (hierarchy is limited to one level), and the child candidate must not already be a parent of other assets.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/addchild/{childRefId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/addchild/{childRefId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset to become the parent. Must be a positive integer. |
childRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset to set as the child. Must be a positive integer. |
Responses:
Sets a parent for the specified asset, linking the two as a parent/child pair. The parent candidate must not itself already have a parent (hierarchy is limited to one level), and the asset becoming a child must not already have a parent.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/addparent/{parentRefId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/addparent/{parentRefId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset to become a child. Must be a positive integer. |
parentRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset to set as the parent. Must be a positive integer. |
Responses:
Update a Asset using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Request Body:
{
"assetTagId": "AST-000001",
"description": "Sample Dell Laptop",
"brand": "Dell",
"model": "Latitude 5420",
"serialNo": "SN-123456789",
"purchaseDate": "2025-01-01",
"purchaseFrom": "Example Vendor Inc.",
"cost": 1200.0,
"siteRefId": 1,
"locationRefId": 1,
"categoryRefId": 1,
"subCategoryRefId": 1,
"departmentRefId": 1,
"depreciationMethod": "StraightLine",
"dateAcquired": "2025-01-01",
"isDepreciable": true,
"initialCost": 1200.0,
"salvageValue": 100.0,
"assetLife": 36,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: UpdateAssetRequest
Responses:
Updates an audit record on the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/audits/{auditRefId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/audits/{auditRefId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
auditRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit. Must be a positive integer. |
Request Body:
{
"auditNameRefId": 1,
"siteRefId": 1,
"locationRefId": 3,
"notes": "Asset verified in expected location.",
"updateAssetLocation": true,
"recordGps": true,
"latitude": 40.712776,
"longitude": -74.005974
}Schema: UpdateAuditRequest
Responses:
Updates the "transact as a whole" flag for the specified asset and propagates the change to its parent and all siblings (or to all its children when the asset is itself a parent).
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/transactaswhole
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/transactaswhole
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset to update. Must be a positive integer. |
transactAsWhole |
boolean | Yes | No | - | New value for the "transact as a whole" flag. True indicates that this asset and its linking assets should be audited/check-out/checked-in, etc., as a group. |
Responses:
Deletes a asset by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
Responses:
Deletes an audit record from the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/audits/{auditRefId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/audits/{auditRefId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the asset. Must be a positive integer. |
auditRefId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit. Must be a positive integer. |
Responses:
Deletes multiple assets by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/assets/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of asset unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Removes the parent link for the specified asset, unlinking it from its parent. If the parent has no remaining children after this, its parent flag is cleared as well.
Production Endpoint:
https://api.assettiger.com/v1/assets/{refId}/deletelink
Sandbox Endpoint:
https://api.assettiger.com/sandbox/assets/{refId}/deletelink
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the child asset whose parent link should be removed. Must be a positive integer. |
Responses:
Retrieves a single audit name by its unique identifier (refId), including whether it is locked and how many active assets have been audited under it.
Production Endpoint:
https://api.assettiger.com/v1/audits/auditnames/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/auditnames/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit name (positive integer only). |
Responses:
Retrieves the list of audit names, including whether each one is locked and how many active assets have been audited under it.
Production Endpoint:
https://api.assettiger.com/v1/audits/auditnames
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/auditnames
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Creates a new audit name. The name must be unique.
Production Endpoint:
https://api.assettiger.com/v1/audits/auditnames/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/auditnames/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "Q3 Inventory Audit"
}Schema: AuditNameRequest
Responses:
Audits multiple assets against one audit name in a single request (maximum 100 assets). Assets that are inactive, not found, outside your access, or already audited under the audit name are skipped. The response returns ```auditedCount``` and ```skippedCount```, plus each skipped asset's RefId and reason in ```skippedAssets```. Returns 422 when none of the assets could be audited.
Production Endpoint:
https://api.assettiger.com/v1/audits/bulkaudit
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/bulkaudit
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"assetRefIds": [
1,
2,
3,
4
],
"auditNameRefId": 1,
"siteRefId": 1,
"locationRefId": 3,
"notes": "Quarterly floor audit.",
"auditDate": "2025-01-01T10:30:00",
"updateAssetLocation": true,
"recordGps": true,
"latitude": 40.712776,
"longitude": -74.005974
}Schema: BulkAuditRequest
Responses:
Locks or unlocks an audit name. While locked, assets cannot be audited against it.
Production Endpoint:
https://api.assettiger.com/v1/audits/auditnames/{refId}/lockunlock
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/auditnames/{refId}/lockunlock
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit name. Must be a positive integer. |
locked |
boolean | Yes | No | - | True to lock the audit name; false to unlock it. |
Responses:
Updates the name of an existing audit name. The new name must be unique.
Production Endpoint:
https://api.assettiger.com/v1/audits/auditnames/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/auditnames/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit name. Must be a positive integer. |
Request Body:
{
"name": "Q3 Inventory Audit"
}Schema: AuditNameRequest
Responses:
Deletes an audit name and all its associated audit records.
Production Endpoint:
https://api.assettiger.com/v1/audits/auditnames/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/audits/auditnames/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the audit name. Must be a positive integer. |
Responses:
Retrieves the details of a bin by its unique identifier (refId). including optional shelf and aisle data if requested.
Production Endpoint:
https://api.assettiger.com/v1/bins/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/bins/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the bin (positive integer only). |
Responses:
Retrieves a list of bins filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/bins
Sandbox Endpoint:
https://api.assettiger.com/sandbox/bins
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
aisleRefId |
int32 | No | Yes | - | Unique identifier (primary key) for the Aisle (positive integer only). Leave this field empty to retrieve unallocated locations. Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bin. |
shelfRefId |
int32 | No | Yes | - | Unique identifier (primary key) for the Shelf (positive integer only). Leave this field empty to retrieve unallocated locations. Required only when the inventory location hierarchy is configured as Shelf > Bins. |
searchKeyword |
string | No | Yes | - | Search keyword to filter bin by name (Search keyword cannot exceed 100 characters.). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by bin name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Schema: BinListRequest
Responses:
Creates a bin using the provided `name` in the request. `aisleRefId` and `shelfRefId` are optional: provide both to create the bin under an aisle/shelf, or omit/null both to create an unallocated bin.
Production Endpoint:
https://api.assettiger.com/v1/bins/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/bins/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"aisleRefId": 1,
"shelfRefId": 1,
"name": "Smart Sign"
}Schema: AddBinRequest
Responses:
Modifies the bin identified by `refId` using the details provided in the request. `aisleRefId` and `shelfRefId` are optional: provide both to (re)assign the bin to an aisle/shelf, or omit/null both to make the bin unallocated.
Production Endpoint:
https://api.assettiger.com/v1/bins/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/bins/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the bin (positive integer only). |
Request Body:
{
"aisleRefId": 1,
"shelfRefId": 1,
"name": "Smart Sign"
}Schema: UpdateBinRequest
Responses:
Deletes a bin by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/bins/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/bins/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the bin (positive integer only). |
Responses:
Retrieves a list of categories filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/categories
Sandbox Endpoint:
https://api.assettiger.com/sandbox/categories
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter categories by name (Search keyword cannot exceed 100 characters.). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by category name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Schema: CategoryListRequest
Responses:
Retrieves the details of a category by its unique identifier (refId). including optional subcategory data if requested.
Production Endpoint:
https://api.assettiger.com/v1/categories/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/categories/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the category (positive integer only). |
fetchSubcategories |
boolean | No | No | False | Indicates whether to include subcategories associated with this category (default: false). |
Responses:
Creates a category using the provided `name` in the request.
Production Endpoint:
https://api.assettiger.com/v1/categories/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/categories/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "Computer Equipment"
}Schema: AddCategoryRequest
Responses:
Modifies the category identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/categories/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/categories/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the category (positive integer only). |
Request Body:
{
"name": "Computer Equipment"
}Schema: UpdateCategoryRequest
Responses:
Deletes multiple categories by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/categories/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/categories/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of category unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Deletes a category by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/categories/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/categories/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the category (positive integer only). |
Responses:
Downloads the contract document identified by refGuid. Returns a binary file stream. **Response:** - Type: File - Format: Binary - Example: budget.pdf
Production Endpoint:
https://api.assettiger.com/v1/contracts/documents/{refGuid}/download
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/documents/{refGuid}/download
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuid |
string | Yes | No | - | Unique GUID of the contract document. |
Responses:
Retrieves all active assets linked to the contract identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}/assets
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}/assets
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Retrieves the details of a single contract by its unique identifier (refId). For a successful response, pass refId = 1.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
fetchCustomFields |
boolean | No | No | False | Indicates whether to include CustomFields associated with this contract (default: false). |
Responses:
Get Contract custom fields.
Production Endpoint:
https://api.assettiger.com/v1/contracts/customfields
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/customfields
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves all documents for the contract identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}/documents
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}/documents
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
Responses:
Get Contract Settings.
Production Endpoint:
https://api.assettiger.com/v1/contracts/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves all contract records.
Production Endpoint:
https://api.assettiger.com/v1/contracts
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter contracts. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text is matched. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "ContractNo" ] | Defines which contract fields are searched. Default: "ContractNo" Allowed values: ContractNo, Description, PersonName, Title, Phone, Vendor. |
searchCustomFields |
[integer] | No | No | - | Defines which contract custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
orderBy |
DataField(Enum) | No | No | - | The field to sort results by. Default: "ContractNo" Allowed values: Title, Description, PersonName, Phone, Hyperlink, ContractNo, ContractCost, Vendor, License, IsSoftware, StartDate, EndDate, CreatedBy. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction. Default: "Asc" Allowed values: Asc, Desc. |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: "false". |
startDate |
date | No | No | - | The start date for filtering contract records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering contract records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField is provided. Default: "EndDate" Allowed values: StartDate, EndDate. |
dateRangeByCustomField |
int32 | No | No | - | Defines which custom date field the filter should apply to. Provide the Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided. |
offset |
int32 | No | No | 0 | The number of records to skip. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: ContractListRequest
Responses:
Creates a new contract using the details provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/contracts/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"contractTitle": "Microsoft 365 Enterprise License",
"description": "Annual enterprise subscription for Microsoft 365 applications and services.",
"hyperlink": "https://www.microsoft.com/microsoft-365",
"contractNo": "MS-2025-001",
"vendor": "Microsoft Corporation",
"contactPerson": "John Smith",
"phone": "\u002B1-555-123-4567",
"cost": 12000.0,
"startDate": "2025-01-01",
"endDate": "2025-12-31",
"licenseCount": 250,
"noEndDate": false,
"softwareContract": true,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: AddContractRequest
Responses:
Links an asset to the contract identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}/assets/associate
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}/assets/associate
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
Request Body:
{
"assetRefId": [
101,
102,
103
]
}Schema: AssociateContractAssetRequest
Responses:
Removes the link between the contract identified by refId and one or more assets.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}/assets/unlink
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}/assets/unlink
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
Request Body:
{
"assetRefIds": [
101,
102
]
}Schema: UnlinkContractAssetsRequest
Responses:
Modifies the contract identified by refId using the details provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
Request Body:
{
"contractTitle": "Office Equipment Maintenance Agreement",
"description": "Maintenance and support contract for office equipment.",
"hyperlink": "https://www.vendor-example.com/contracts",
"contractNo": "MAINT-2025-101",
"vendor": "Tech Services Ltd.",
"contactPerson": "Sarah Johnson",
"phone": "\u002B1-555-987-6543",
"cost": 3500.0,
"startDate": "2025-04-01",
"endDate": null,
"licenseCount": null,
"noEndDate": true,
"softwareContract": false,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: UpdateContractRequest
Responses:
Deletes the contract identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/contracts/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the contract (positive integer only). |
Responses:
Deletes the contract document identified by refGuid.
Production Endpoint:
https://api.assettiger.com/v1/contracts/documents/{refGuid}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/contracts/documents/{refGuid}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuid |
string | Yes | No | - | Unique GUID of the contract document. |
Responses:
Retrieves the details of a customer by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/customers/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the customer (positive integer only). |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result (default: false). |
Responses:
Get Customer custom fields.
Production Endpoint:
https://api.assettiger.com/v1/customers/customfields
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/customfields
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Get Customer Settings.
Production Endpoint:
https://api.assettiger.com/v1/customers/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves a list of customers filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/customers
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter customer by name (cannot exceed 100 characters). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains". Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
searchFields |
[DataField(Enum)] | No | Yes | [ "Name", "Email", "Phone", "Company" ] | Defines which customers fields can be searched. Default: "Name", "Email", "Phone", "Company" Allowed values: Name, Email, Phone, Company. |
searchCustomFields |
[integer] | No | No | - | Defines which customer custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Default: "Name". Allowed values: Name, Company, Address1, Address2, City, State, Zip, Country, Phone, Cell, Notes, Email, CreatedBy. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc". |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: false. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: 0. |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: 20. Must be between 1 and 100. |
Schema: CustomerListRequest
Responses:
Creates a customer using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/customers/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "John Doe",
"company": "Example Company",
"address1": "123 Example Street",
"address2": "Suite 100",
"city": "Sample City",
"state": "Example State",
"zip": "00000",
"countryRefId": 221,
"phone": "0000000000",
"cell": "0000000000",
"email": "[email protected]",
"notes": "Sample note",
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Value"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: AddCustomerRequest
Responses:
Modifies the Customer identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/customers/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the customer (positive integer only). |
Request Body:
{
"name": "John Doe",
"company": "Example Company",
"address1": "123 Example Street",
"address2": "Suite 100",
"city": "Sample City",
"state": "Example State",
"zip": "00000",
"countryRefId": 221,
"phone": "0000000000",
"cell": "0000000000",
"email": "[email protected]",
"notes": "Sample note",
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Value"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: UpdateCustomerRequest
Responses:
Deletes a customer by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/customers/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the customer (positive integer only). |
Responses:
Deletes multiple customers by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/customers/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/customers/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of customer unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Retrieves the details of a department by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/departments/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/departments/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the department (positive integer only). |
Responses:
Retrieves a list of departments filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/departments
Sandbox Endpoint:
https://api.assettiger.com/sandbox/departments
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter departments by name (Search keyword cannot exceed 100 characters.). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by department name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Responses:
Creates a department using the provided `name` in the request.
Production Endpoint:
https://api.assettiger.com/v1/departments/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/departments/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "It"
}Schema: AddDepartmentRequest
Responses:
Modifies the department identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/departments/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/departments/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the department (positive integer only). |
Request Body:
{
"name": "It"
}Schema: UpdateDepartmentRequest
Responses:
Deletes a department by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/departments/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/departments/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the department (positive integer only). |
Responses:
Deletes multiple departments by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/departments/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/departments/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of department unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Downloads the fund document identified by refGuid. Returns a binary file stream. **Response:** - Type: File - Format: Binary - Example: budget.pdf
Production Endpoint:
https://api.assettiger.com/v1/funds/documents/{refGuid}/download
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/documents/{refGuid}/download
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuid |
string | Yes | No | - | Unique GUID of the fund document. |
Responses:
Retrieves all active assets linked to the fund identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}/assets
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}/assets
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Retrieves the details of a single fund by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
Responses:
Retrieves all documents for the fund identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}/documents
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}/documents
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
Responses:
Retrieves all fund records.
Production Endpoint:
https://api.assettiger.com/v1/funds
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter funds. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text is matched. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "Name" ] | Defines which fund fields are searched. Default: "Name" Allowed values: Name, Description, Notes. |
orderBy |
DataField(Enum) | No | No | - | The field to sort results by. Default: "EndDate" Allowed values: Name, Description, FundAmount, StartDate, EndDate. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction. Default: "Asc" Allowed values: Asc, Desc. |
startDate |
date | No | No | - | The start date for filtering fund records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering fund records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filter applies to. Default: "EndDate" Allowed values: StartDate, EndDate. |
offset |
int32 | No | No | 0 | The number of records to skip. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: FundListRequest
Responses:
Creates a new fund using the details provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/funds/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "Capital Equipment Fund",
"description": "Used for capital equipment purchases",
"amount": 50000.0,
"startDate": "2024-01-01",
"endDate": "2024-12-31",
"notes": "Annual budget cycle",
"active": true
}Schema: AddFundRequest
Responses:
Links an asset to the fund identified by refId and records the debited amount.
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}/assets/associate
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}/assets/associate
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
Request Body:
{
"assetRefId": 101,
"amount": 1800.0
}Schema: AssociateFundAssetRequest
Responses:
Removes the link between the fund identified by refId and one or more assets provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}/assets/unlink
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}/assets/unlink
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
Request Body:
{
"assetRefIds": [
101,
102
]
}Schema: UnlinkFundAssetsRequest
Responses:
Modifies the fund identified by refId using the details provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
Request Body:
{
"name": "Capital Equipment Fund",
"description": "Used for capital equipment purchases",
"amount": 50000.0,
"startDate": "2024-01-01",
"endDate": "2024-12-31",
"notes": "Annual budget cycle",
"active": true
}Schema: UpdateFundRequest
Responses:
Deletes the fund identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/funds/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the fund (positive integer only). |
Responses:
Deletes the fund document identified by refGuid.
Production Endpoint:
https://api.assettiger.com/v1/funds/documents/{refGuid}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/funds/documents/{refGuid}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuid |
string | Yes | No | - | Unique GUID of the fund document. |
Responses:
Download Document by its unique identifier (refGuId). Returns a binary file stream. **Response:** - Type: File - Format: Binary - Example: sample.pdf
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}/download
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}/download
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
Responses:
Download Image by its unique identifier (refGuId). Returns a binary file stream. **Response:** - Type: File - Format: Binary - Example: sample.jpg
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}/download
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}/download
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
Responses:
Retrieves the details of a Document by its unique identifier `refGuId `.
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
Responses:
Retrieves collection of documents filtered and sorted based on the provided query parameters. Supports searching keywords, and various fields, with flexible sorting and pagination options.
Production Endpoint:
https://api.assettiger.com/v1/documents
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter documents by defined document search fields. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "Name", "Description" ] | Defines which document fields can be searched. Default: "Name", "Description" Allowed values include: Name, Description. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Allowed values: Name, Description. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: DocumentListRequest
Responses:
Retrieves the details of a Image by its unique identifier `refGuId `.
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
Responses:
Retrieves collection of images filtered and sorted based on the provided query parameters. Supports searching keywords, and various fields, with flexible sorting and pagination options.
Production Endpoint:
https://api.assettiger.com/v1/images
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter images by defined image search fields. Maximum length: 100 characters. |
imageType |
ImageType(Enum) | No | No | - | Specifies the image assignment filter to apply. Default: "ShowAll" Allowed values: ShowAll, Assigned, UnAssigned. |
isStock |
boolean | No | No | False | fetch stock images. Default: "False" |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: ImageListRequest
Responses:
Links the specified document to the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}/attach/asset/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}/attach/asset/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the asset. |
Responses:
Links the specified document to the specified inventory item.
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}/attach/inventoryitem/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}/attach/inventoryitem/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the inventory item. |
Responses:
Links the specified image to the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}/attach/asset/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}/attach/asset/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the asset. |
Responses:
Links the specified image to the specified inventory item.
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}/attach/inventoryitem/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}/attach/inventoryitem/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the inventory item. |
Responses:
Removes the link between the specified document and the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}/detach/asset/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}/detach/asset/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the asset. |
Responses:
Removes the link between the specified document and the specified inventory item.
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}/detach/inventoryitem/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}/detach/inventoryitem/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the inventory item. |
Responses:
Removes the link between the specified image and the specified asset.
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}/detach/asset/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}/detach/asset/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the asset. |
Responses:
Removes the link between the specified image and the specified inventory item.
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}/detach/inventoryitem/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}/detach/inventoryitem/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
refId |
int32 | Yes | No | - | Unique identifier (refId) of the inventory item. |
Responses:
Deletes a Document by refGuId.
Production Endpoint:
https://api.assettiger.com/v1/documents/{refGuId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/documents/{refGuId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the document. |
Responses:
Deletes a Image by refGuId.
Production Endpoint:
https://api.assettiger.com/v1/images/{refGuId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/images/{refGuId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuId |
string | Yes | No | - | Unique identifier (refGuId) of the image. |
Responses:
Retrieves countries.
Production Endpoint:
https://api.assettiger.com/v1/countries
Sandbox Endpoint:
https://api.assettiger.com/sandbox/countries
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves currencies.
Production Endpoint:
https://api.assettiger.com/v1/currencies
Sandbox Endpoint:
https://api.assettiger.com/sandbox/currencies
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves date format.
Production Endpoint:
https://api.assettiger.com/v1/dateformats
Sandbox Endpoint:
https://api.assettiger.com/sandbox/dateformats
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves TimeFormat.
Production Endpoint:
https://api.assettiger.com/v1/timeformats
Sandbox Endpoint:
https://api.assettiger.com/sandbox/timeformats
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves timeZones.
Production Endpoint:
https://api.assettiger.com/v1/timezones
Sandbox Endpoint:
https://api.assettiger.com/sandbox/timezones
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Downloads the insurance document identified by refGuid. Returns a binary file stream. **Response:** - Type: File - Format: Binary - Example: budget.pdf
Production Endpoint:
https://api.assettiger.com/v1/insurances/documents/{refGuid}/download
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/documents/{refGuid}/download
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuid |
string | Yes | No | - | Unique GUID of the insurance document. |
Responses:
Retrieves all active assets linked to the insurance identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}/assets
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}/assets
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Retrieves the details of a single insurance by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
Responses:
Retrieves all documents for the insurance identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}/documents
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}/documents
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
Responses:
Retrieves all insurance records.
Production Endpoint:
https://api.assettiger.com/v1/insurances
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter insurances. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text is matched. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "InsuranceCo" ] | Defines which insurance fields are searched. Default: "InsuranceCo" Allowed values: InsuranceCo, Description, PersonName, Policy, Phone, Coverage, Email, Limits. |
orderBy |
DataField(Enum) | No | No | - | The field to sort results by. Default: "InsuranceCo" Allowed values: InsuranceCo, Description, PersonName, Phone, Email, Policy, Coverage, Limits, StartDate, EndDate. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction. Default: "Asc" Allowed values: Asc, Desc. |
startDate |
date | No | No | - | The start date for filtering insurance records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering insurance records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filter applies to. Default: "EndDate" Allowed values: StartDate, EndDate. |
offset |
int32 | No | No | 0 | The number of records to skip. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: InsuranceListRequest
Responses:
Creates a new insurance using the details provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/insurances/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"insuranceCo": "ABC Insurance Ltd.",
"description": "Comprehensive insurance coverage for office equipment and assets",
"person": "John Smith",
"phone": "555-123-4567",
"email": "[email protected]",
"policy": "POL-2024-001",
"coverage": "Asset Damage and Theft",
"limits": "$500,000",
"deductible": 1000.0,
"premium": 5000.0,
"startDate": "2024-01-01",
"endDate": "2024-12-31",
"active": true
}Schema: AddInsuranceRequest
Responses:
Links an asset to the insurance identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}/assets/associate
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}/assets/associate
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
Request Body:
{
"assetRefId": [
101,
102,
103
]
}Schema: AssociateInsuranceAssetRequest
Responses:
Removes the link between the insurance identified by refId and one or more assets.
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}/assets/unlink
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}/assets/unlink
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
Request Body:
{
"assetRefIds": [
101,
102
]
}Schema: UnlinkInsuranceAssetsRequest
Responses:
Modifies the insurance identified by refId using the details provided in the request body.
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
Request Body:
{
"insuranceCo": "ABC Insurance Ltd.",
"description": "Comprehensive insurance coverage for office equipment and assets",
"person": "John Smith",
"phone": "55-123-4567",
"email": "[email protected]",
"policy": "POL-2024-001",
"coverage": "Asset Damage and Theft",
"limits": "$500,000",
"deductible": 1000.0,
"premium": 5000.0,
"startDate": "2024-01-01",
"endDate": "2024-12-31",
"active": true
}Schema: UpdateInsuranceRequest
Responses:
Deletes the insurance identified by refId.
Production Endpoint:
https://api.assettiger.com/v1/insurances/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the insurance (positive integer only). |
Responses:
Deletes the insurance document identified by refGuid.
Production Endpoint:
https://api.assettiger.com/v1/insurances/documents/{refGuid}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/insurances/documents/{refGuid}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refGuid |
string | Yes | No | - | Unique GUID of the insurance document. |
Responses:
Retrieves collection of inventory items filtered and sorted based on the provided query parameters. Supports searching by category, subcategory, keywords, and various fields, with flexible sorting and pagination options.
Production Endpoint:
https://api.assettiger.com/v1/inventories
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter inventories by defined inventory search fields. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "InventoryTagId", "Description" ] | Defines which inventory fields can be searched. Default: "InventoryTagId", "Description" Allowed values include: InventoryTagId, Description, Unit, SKU, Brand, Model, Size, Style, Color, Notes, Vendor, Url. |
searchCustomFields |
[integer] | No | No | - | Defines which inventory custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
categoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories. |
subCategoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories. |
stock |
StockType(Enum) | No | No | - | Defines the stock filter for the inventory list. Default: "All" Allowed values: All, Ideal, IdealAndLow, IdealAndOverflow, Low, LowAndOverflow, Overflow. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Allowed values: InventoryTagId, Description, Unit, Stock, SKU, Brand, Model, Size, Style, Color, Notes, Vendor, Url, MinQty, MaxQty, DateCreated, CreatedBy, CategoryName, SubCategoryName. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc. |
startDate |
date | No | No | - | The start date for filtering inventory records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering inventory records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField is provided. Default: "DateCreated" Allowed values: DateCreated. |
dateRangeByCustomField |
int32 | No | No | - | Defines which custom date field the filter should apply to. Provide the Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided. |
fetchCategoryName |
boolean | No | No | False | Whether to include category name in the result. Default: "false". |
fetchSubCategoryName |
boolean | No | No | False | Whether to include subcategory name in the result. Default: "false". |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: "false". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: InventoryListRequest
Responses:
Retrieves the details of a inventory item by its unique identifier (refId). It supports optional query parameters to include related data such as custom fields, images, and documents.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
fetchCategorytName |
boolean | No | No | False | Whether to include category name. |
fetchSubCategorytName |
boolean | No | No | False | Whether to include subcategory name. |
fetchDefaultImageDetail |
boolean | No | No | False | Whether to include detailed information of the default image. |
fetchImages |
boolean | No | No | False | Whether to include all images associated with the inventory item. Default: "false" |
fetchDocuments |
boolean | No | No | False | Whether to include documents associated with the inventory item. Default: "false" |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields associated with the inventory item. Default: "false" |
Responses:
Retrieves the details of a inventory item by its unique identifier `inventoryTagId `. It supports optional query parameters to include related data such as custom fields, images, and documents.
Production Endpoint:
https://api.assettiger.com/v1/inventories/bytagId/{inventoryTagId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/bytagId/{inventoryTagId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
inventoryTagId |
string | Yes | No | - | Unique tag or code assigned to the inventory item for tracking. |
fetchCategorytName |
boolean | No | No | False | Whether to include category name. |
fetchSubCategorytName |
boolean | No | No | False | Whether to include subcategory name. |
fetchDefaultImageDetail |
boolean | No | No | False | Whether to include detailed information of the default image. |
fetchImages |
boolean | No | No | False | Whether to include all images associated with the inventory item. Default: "false" |
fetchDocuments |
boolean | No | No | False | Whether to include documents associated with the inventory item. Default: "false" |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields associated with the inventory item. Default: "false" |
Responses:
Get Inventory custom fields.
Production Endpoint:
https://api.assettiger.com/v1/inventories/customfields
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/customfields
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves the list of documents linked to a given inventory item, including metadata such as file name, description, upload date, type.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/documents
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/documents
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item (positive integer only). |
Responses:
Retrieves the details of a inventory history by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/histories
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/histories
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Desc" Allowed values: Asc, Desc. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: InventoryItemHistoryListRequest
Responses:
Retrieves a single inventory history record by the history's unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/inventories/histories/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/histories/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory history record (positive integer only). |
Responses:
Retrieves the list of images linked to a given inventory item along with metadata such as file name, upload date, and URL paths.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/images
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/images
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item (positive integer only). |
Responses:
Get Inventory Settings
Production Endpoint:
https://api.assettiger.com/v1/inventories/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves the stock summary of a inventory item by its unique identifier (refId), as one entry per storage location (Aisle/Shelf/Bin combination) that currently holds stock.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/stocksummary
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/stocksummary
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
Responses:
Retrieves the details of a inventory transactions by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/inventories/transactions/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/transactions/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item transaction. Must be a positive integer. |
Responses:
Retrieves the details of a inventory transactions by inventory item unique identifier (refId) RefId.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/transactions
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/transactions
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
TransactionType |
InventoryEvent(Enum) | No | Yes | - | Defines which transaction type include in result. Default All type transaction included in result. Allowed values include: Opening, Adjustment, AddStock, RemoveStock, Movement. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Desc" Allowed values: Asc, Desc. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Responses:
Creates a inventory item using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/inventories/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"inventoryTagId": "INV-000001",
"description": "Sample 24-inch Monitor",
"quantity": 5,
"categoryRefId": 1,
"subCategoryRefId": 1,
"notes": "Sample inventory record",
"sku": "SKU-001",
"brand": "Example Brand",
"model": "Model-X",
"vendor": "Sample Vendor",
"url": "https://example.com/product",
"size": "24-inch",
"color": "Black",
"style": "Standard",
"unit": "Piece",
"minQty": 1,
"maxQty": 100,
"hasMaxQtyAlert": false,
"hasMinQtyAlert": false,
"minQtyAlert": null,
"maxQtyAlert": null,
"openingDate": "2026-11-04",
"unitCost": 100.0,
"totalCost": 500.0,
"refNo": "REF-001",
"aisle": "A1",
"shelf": "S1",
"bin": "B1",
"eventNotes": "Sample stock entry",
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Location"
},
{
"customFieldId": 2,
"customFieldValue": "Sample Batch"
}
]
}Schema: AddInventoryItemRequest
Responses:
Creates a new inventory transaction (AddStock, RemoveStock, Adjustment Or Stock Movement) for the specified inventory item.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/transactions/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/transactions/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
Request Body:
{
"eventType": "AddStock",
"quantity": 10,
"isAddToStock": true,
"eventDate": "2026-11-04",
"personRefId": 1,
"customerRefId": null,
"personName": null,
"unitCost": 100.0,
"totalCost": 1000.0,
"refNo": "REF-001",
"notes": "this is test notes",
"aisle": "A1",
"shelf": "S1",
"bin": "B1",
"locations": [
{
"aisleRefId": 1,
"shelfRefId": 10,
"binRefId": 100,
"quantity": 6
},
{
"aisleRefId": 1,
"shelfRefId": 10,
"binRefId": 101,
"quantity": 4
}
],
"fromLocations": null,
"toLocations": null
}Schema: AddTransactionRequest
Responses:
Update a inventory item using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
Request Body:
{
"inventoryTagId": "INV-000001",
"description": "Sample 24-inch Monitor",
"categoryRefId": 1,
"subCategoryRefId": 1,
"notes": "Sample inventory record",
"sku": "SKU-001",
"brand": "Example Brand",
"model": "Model-X",
"vendor": "Sample Vendor",
"url": "https://example.com/product",
"size": "24-inch",
"color": "Black",
"style": "Standard",
"unit": "Piece",
"minQty": 1,
"maxQty": 100,
"hasMaxQtyAlert": false,
"hasMinQtyAlert": false,
"minQtyAlert": null,
"maxQtyAlert": null,
"openingDate": "2026-11-04",
"unitCost": 100.0,
"totalCost": 500.0,
"refNo": "REF-001",
"aisle": "A1",
"shelf": "S1",
"bin": "B1",
"eventNotes": "Sample stock entry",
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Location"
},
{
"customFieldId": 2,
"customFieldValue": "Sample Batch"
}
]
}Schema: UpdateInventoryItemRequest
Responses:
Update inventory transaction using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/inventories/transactions/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/transactions/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory transaction. Must be a positive integer. |
Request Body:
{
"personRefId": 1,
"customerRefId": 1,
"personName": "Jhon",
"eventDate": "2026-11-04",
"unitCost": 100.0,
"totalCost": 500.0,
"refNo": "REF-001",
"notes": "this is test notes",
"aisle": "A1",
"shelf": "S1",
"bin": "B1"
}Schema: UpdateTransactionRequest
Responses:
Deletes a Inventory Item by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/inventories/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the inventory item. Must be a positive integer. |
Responses:
Deletes multiple Inventory Items by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/inventories/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/inventories/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of inventory item unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Retrieves the details of a location by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/locations/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique reference ID of the location (positive integer only). |
fetchSite |
boolean | No | No | False | Whether to include the parent site associated with this location (default: false). |
Responses:
Retrieves a paginated, filtered list of all active locations.
Production Endpoint:
https://api.assettiger.com/v1/locations
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
siteRefId |
int32 | Yes | No | - | Unique identifier (primary key) for the site (positive integer only). |
searchKeyword |
string | No | Yes | - | Search keyword to filter locations by name (cannot exceed 100 characters). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by location name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
fetchSite |
boolean | No | No | False | Whether to include the parent site associated with each location in the result. Default: "false" |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Schema: LocationListRequest
Responses:
Creates a new location under a site using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/locations/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "HQ Floor 1",
"siteRefId": 1,
"description": "First floor of the headquarters building"
}Schema: AddLocationRequest
Responses:
Modifies the location identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/locations/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the location (positive integer only). |
Request Body:
{
"name": "HQ Floor 1",
"siteRefId": 1,
"description": "First floor of the headquarters building"
}Schema: UpdateLocationRequest
Responses:
Deletes a location by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/locations/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the location (positive integer only). |
Responses:
Deletes multiple locations by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/locations/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of location unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Deletes all locations belonging to the site identified by siteRefId.
Production Endpoint:
https://api.assettiger.com/v1/locations/bysiterefId/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/locations/bysiterefId/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
siteRefId |
int32 | Yes | No | - | Unique identifier (primary key) for the site (positive integer only). |
Responses:
Retrieves the details of a maintenance by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/maintenances/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/maintenances/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the maintenance (positive integer only). |
fetchCustomFields |
boolean | No | No | False | Indicates whether to include custom fields associated with this maintenance (default: false). |
Responses:
Get Maintenance Settings.
Production Endpoint:
https://api.assettiger.com/v1/maintenances/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/maintenances/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves a list of maintenance filtered and sorted based on the provided query parameters. Supports keyword search, maintenance and asset custom field search, filtering by category/ subcategory, site/location, department, person, customer, and event type, and date-range filtering by expiry date, an asset date, a maintenance custom field, or an asset custom field (requires startDate and endDate when dateRangeByCustomField or dateRangeByAssetCustomField is provided), sorting, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/maintenances
Sandbox Endpoint:
https://api.assettiger.com/sandbox/maintenances
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter maintenances by defined search fields. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "AssetTagId", "Description", "Title" ] | Defines which maintenance fields can be searched. Default: "AssetTagId", "Description", "Title". Allowed values include: Title, Details, MaintenanceBy, AssetTagId, Description, PurchaseFrom, Brand, Model, SerialNo. |
searchCustomFields |
[integer] | No | No | - | Defines which maintenance custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
searchAssetCustomFields |
[integer] | No | No | - | Defines which asset custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
categoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories. |
subCategoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories. |
siteRefId |
int32 | No | No | - | Unique identifier (primary key) of the site to filter by. Pass 0 to filter unassigned sites. |
locationRefId |
int32 | No | No | - | Unique identifier (primary key) of the location to filter by. If provided, siteRefId must also be specified. Pass 0 to filter unassigned locations. |
departmentRefId |
int32 | No | No | - | Unique identifier (primary key) of the department to filter by. Pass 0 to filter unassigned departments. |
personRefId |
int32 | No | No | - | Unique identifier (primary key) of the assigned person to filter by. |
customerRefId |
int32 | No | No | - | Unique identifier (primary key) of the assigned customer to filter by. |
EventTypes |
EventType(Enum) | No | Yes | - | Filters assets by the specified event types. Selecting "Custom" includes all user-defined custom events. |
maintenanceStatus |
MaintenanceStatus(Enum) | No | Yes | - | Filters results to only maintenance records with the specified status(es). Allowed values: Scheduled, InProgress, OnHold, Cancelled, Completed. Omit to return records in any status. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Default: "DueDate". Allowed values: DueDate, DateCompleted, AssetTagId, Description, Brand, Model, SerialNo, PurchaseDate, DateCreated, CreatedBy, MaintAssignedTo, MaintDetail, MaintTitle, MaintStatus, Repeating, RepairCost, Frequency, RecurOn1, RecurOn2, Cost, PurchaseFrom, InitialCost, SiteName, LocationName, CategoryName, SubCategoryName, DepartmentName, isDepreciable, SalvageValue, AssetLife, DepreciationMethodName, DateAcquired, Status, PersonName, LeaseTo, Reservation, EventDate1, EventDate2, Relation, IsLinked, CurrentCost. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc. |
startDate |
date | No | No | - | The start date for filtering maintenance records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering maintenance records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField or dateRangeByAssetCustomField is provided. Default: "DueDate" Allowed values: DueDate, DateCompleted, DateCreated, PurchaseDate, DateAcquired. |
dateRangeByCustomField |
int32 | No | No | - | Defines which maintenance custom date field the filter should apply to. Provide the maintenance Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided. |
dateRangeByAssetCustomField |
int32 | No | No | - | Defines which asset custom date field the filter should apply to. Provide the asset Custom Field ID to enable this filter, which takes precedence over dateRangeBy and dateRangeByCustomField when set. Requires startDate and endDate to also be provided. |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: "false". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: MaintenanceListRequest
Responses:
Creates an Asset Maintenance using the provided request. The response always includes refId, the id of the created record, and nextRecurrRefId. If Repeating is true and Status is Completed or Cancelled, a next-occurrence maintenance record is created automatically and nextRecurrRefId is set to its id; otherwise nextRecurrRefId is null.
Production Endpoint:
https://api.assettiger.com/v1/maintenances/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/maintenances/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"assetRefId": 1,
"title": "Quarterly Inspection",
"details": "Inspect and service the unit.",
"dueDate": "2025-01-01",
"maintenanceBy": "John Smith",
"status": "Scheduled",
"cost": 150.0,
"dateCompleted": null,
"repeating": true,
"frequency": "Monthly",
"recurEvery": 3,
"recurOn": 15,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: MaintenanceRequest
Responses:
Updates a maintenance using the provided request. Normally returns 204 No Content. If Repeating is true and Status is Completed or Cancelled, a next-occurrence maintenance record is created automatically, and the endpoint instead returns 201 Created with nextRecurrRefId containing that record's id.
Production Endpoint:
https://api.assettiger.com/v1/maintenances/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/maintenances/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the maintenance. Must be a positive integer. |
Request Body:
{
"assetRefId": 1,
"title": "Quarterly Inspection",
"details": "Inspect and service the unit.",
"dueDate": "2025-01-01",
"maintenanceBy": "John Smith",
"status": "Scheduled",
"cost": 150.0,
"dateCompleted": null,
"repeating": true,
"frequency": "Monthly",
"recurEvery": 3,
"recurOn": 15,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: MaintenanceRequest
Responses:
Deletes a maintenance by its unique reference ID, scoped to the asset it belongs to (both refId and assetRefId are required).
Production Endpoint:
https://api.assettiger.com/v1/maintenances/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/maintenances/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"refId": 1,
"assetRefId": 101
}Schema: DeleteMaintenanceRequest
Responses:
Retrieves the details of a person by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/persons/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the person (positive integer only). |
fetchSiteName |
boolean | No | No | False | Whether to include site name in the result (default: false). |
fetchLocationName |
boolean | No | No | False | Whether to include location name in the result (default: false). |
fetchDepartmentName |
boolean | No | No | False | Whether to include department name in the result (default: false). |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result (default: false). |
Responses:
Get person custom fields.
Production Endpoint:
https://api.assettiger.com/v1/persons/customfields
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/customfields
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Get persons Settings.
Production Endpoint:
https://api.assettiger.com/v1/persons/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Retrieves a list of persons filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/persons
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter person by name (cannot exceed 100 characters). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains". Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
searchFields |
[DataField(Enum)] | No | Yes | [ "Name", "EmpID", "Title", "Email", "Phone" ] | Defines which person fields can be searched. Default: "Name", "Title", "Email", "Phone", "EmpID" Allowed values: Name, EmpID, Title, Email, Phone. |
searchCustomFields |
[integer] | No | No | - | Defines which person custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Default: "Name". Allowed values: Name, EmpID, Title, Email, Phone, Notes, SiteName, LocationName, DepartmentName, CreatedBy. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc". |
fetchSiteName |
boolean | No | No | False | Whether to include site name in the result. Default: false. |
fetchLocationName |
boolean | No | No | False | Whether to include location name in the result. Default: false. |
fetchDepartmentName |
boolean | No | No | False | Whether to include department name in the result. Default: false. |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: false. |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: 0. |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: 20. Must be between 1 and 100. |
Schema: PersonListRequest
Responses:
Creates a person using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/persons/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "John Doe",
"title": "Mr",
"phone": "(555) 123-4567",
"email": "[email protected]",
"notes": "Sample employee record",
"empId": "EMP-001",
"siteRefId": 1,
"locationRefId": 1,
"departmentRefId": 1,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: AddPersonRequest
Responses:
Modifies the Person identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/persons/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the person (positive integer only). |
Request Body:
{
"name": "John Doe",
"title": "Mr",
"phone": "(555) 123-4567",
"email": "[email protected]",
"notes": "Sample employee record",
"empId": "EMP-001",
"siteRefId": 1,
"locationRefId": 1,
"departmentRefId": 1,
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: UpdatePersonRequest
Responses:
Deletes a person by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/persons/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the person (positive integer only). |
Responses:
Deletes multiple persons by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/persons/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/persons/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of person unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Retrieves the details of a shelf by its unique identifier (refId). including optional aisle and bin data if requested.
Production Endpoint:
https://api.assettiger.com/v1/shelves/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/shelves/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the shelf (positive integer only). |
fetchBins |
boolean | No | No | - | Indicates whether to include bins associated with this ailse/shelves (default: false). |
Responses:
Retrieves a list of shelves filtered by optional parameters such as search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/shelves
Sandbox Endpoint:
https://api.assettiger.com/sandbox/shelves
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
aisleRefId |
int32 | No | Yes | - | Unique identifier (primary key) for the Aisle (positive integer only). Leave this field empty to retrieve unallocated locations. Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bins. |
searchKeyword |
string | No | Yes | - | Search keyword to filter shelves by name (Search keyword cannot exceed 100 characters.). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by shelf name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Schema: ShelfListRequest
Responses:
Creates a shelf using the provided `name` in the request. `aisleRefId` is optional: provide it to create the shelf under an aisle, or omit/null it to create an unallocated shelf.
Production Endpoint:
https://api.assettiger.com/v1/shelves/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/shelves/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"aisleRefId": 1,
"name": "New York"
}Schema: AddShelfRequest
Responses:
Modifies the shelf identified by `refId` using the details provided in the request. `aisleRefId` is optional: provide it to (re)assign the shelf to an aisle, or omit/null it to make the shelf unallocated.
Production Endpoint:
https://api.assettiger.com/v1/shelves/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/shelves/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the shelf (positive integer only). |
Request Body:
{
"aisleRefId": 1,
"name": "New York"
}Schema: UpdateShelfRequest
Responses:
Deletes a shelf by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/shelves/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/shelves/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the shelf (positive integer only). |
Responses:
Retrieves the details of a site by its unique identifier (refId). including optional locations data if requested.
Production Endpoint:
https://api.assettiger.com/v1/sites/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/sites/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the site (positive integer only). |
fetchLocations |
boolean | No | No | False | Indicates whether to include locations associated with this site (default: false). |
Responses:
Retrieves a paginated, filtered list of all active sites.
Production Endpoint:
https://api.assettiger.com/v1/sites
Sandbox Endpoint:
https://api.assettiger.com/sandbox/sites
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter sites by name (cannot exceed 100 characters). |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by site name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Schema: SiteListRequest
Responses:
Creates a new site using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/sites/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/sites/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"name": "Head Office",
"address1": "123 Example Street",
"address2": "Suite 100",
"city": "Sample City",
"state": "Example State",
"zip": "00000",
"countryRefId": 221,
"description": "Main headquarters"
}Schema: AddSiteRequest
Responses:
Modifies the site identified by `refId` using the details provided in the request.
Production Endpoint:
https://api.assettiger.com/v1/sites/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/sites/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the site (positive integer only). |
Request Body:
{
"name": "Head Office",
"address1": "123 Example Street",
"address2": "Suite 100",
"city": "Sample City",
"state": "Example State",
"zip": "00000",
"countryRefId": 221,
"description": "Main headquarters"
}Schema: UpdateSiteRequest
Responses:
Deletes a site by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/sites/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/sites/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the site (positive integer only). |
Responses:
Deletes multiple sites by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/sites/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/sites/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of site unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Retrieves a list of subcategories filtered by optional parameters such as categoryRefId, search keyword, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/subcategories
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
categoryRefId |
int32 | Yes | No | - | Unique identifier (primary key) for the category (positive integer only). |
searchKeyword |
string | No | Yes | - | Search keyword to filter subcategories by name (Search keyword cannot exceed 100 characters.) |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith". |
orderBy |
DataField(Enum) | No | No | - | The field to order results by subcategory name. Default: "Name" Allowed values: "Name". |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc". |
fetchCategory |
boolean | No | No | False | Whether to include category in the result. Default: "false". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100. |
Responses:
Retrieves the details of a subcategory by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/subcategories/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique reference ID of the subcategory (positive integer only). |
fetchCategory |
boolean | No | No | - | Whether to include the parent category associated with this subcategory. |
Responses:
Creates a new subcategory under the specified category.
Production Endpoint:
https://api.assettiger.com/v1/subcategories/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"categoryRefId": 1,
"name": "Laptop"
}Schema: AddSubCategoryRequest
Responses:
Move subcategory to another category.
Production Endpoint:
https://api.assettiger.com/v1/subcategories/{refId}/move
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/{refId}/move
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique reference ID of the subcategory (positive integer only). |
Request Body:
{
"categoryRefId": 1
}Schema: MoveSubCategoryRequest
Responses:
Updates the name or associated category of an existing subcategory.
Production Endpoint:
https://api.assettiger.com/v1/subcategories/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique reference ID of the subcategory (positive integer only). |
Request Body:
{
"name": "Server"
}Schema: UpdateSubCategoryRequest
Responses:
Deletes multiple subcategories by their reference IDs.
Production Endpoint:
https://api.assettiger.com/v1/subcategories/deletebulk
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/deletebulk
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefIds |
[integer] | Yes | No | - | Collection of subcategory unique identifiers (RefIds) to delete. Maximum 100 items. |
Responses:
Deletes Subcategories by Category reference ID.
Production Endpoint:
https://api.assettiger.com/v1/subcategories/bycatrefId/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/bycatrefId/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
categoryRefId |
int32 | Yes | No | - | Unique identifier (primary key) for the category. |
Responses:
Deletes a subcategory by its unique reference ID.
Production Endpoint:
https://api.assettiger.com/v1/subcategories/{refId}/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/subcategories/{refId}/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique reference ID of the subcategory (positive integer only). |
Responses:
Retrieves the details of a user by its unique GUID.
Production Endpoint:
https://api.assettiger.com/v1/users/{RefGuId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/users/{RefGuId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
RefGuId |
string | Yes | No | - | Unique GUID of the user. |
Responses:
Retrieves a list of warranties filtered and sorted based on the provided query parameters. Supports keyword search, warranty and asset custom field search, filtering by category/ subcategory, site/location, department, person, customer, and event type, and date-range filtering by expiry date, an asset date, a warranty custom field, or an asset custom field (requires startDate and endDate when dateRangeByCustomField or dateRangeByAssetCustomField is provided), sorting, and pagination.
Production Endpoint:
https://api.assettiger.com/v1/warranties
Sandbox Endpoint:
https://api.assettiger.com/sandbox/warranties
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
searchKeyword |
string | No | Yes | - | Search keyword to filter warranties by defined search fields. Maximum length: 100 characters. |
searchType |
SearchType(Enum) | No | No | - | Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith. |
searchFields |
[DataField(Enum)] | No | Yes | [ "AssetTagId", "Description", "Notes" ] | Defines which asset fields can be searched. Default: "AssetTagId", "Description", "Notes". Allowed values include: AssetTagId, Description, Notes, PurchaseFrom, Brand, Model, SerialNo. |
searchCustomFields |
[integer] | No | No | - | Defines which warranty custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
searchAssetCustomFields |
[integer] | No | No | - | Defines which asset custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES. |
categoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories. |
subCategoryRefId |
int32 | No | No | - | Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories. |
siteRefId |
int32 | No | No | - | Unique identifier (primary key) of the site to filter by. Pass 0 to filter unassigned sites. |
locationRefId |
int32 | No | No | - | Unique identifier (primary key) of the location to filter by. If provided, siteRefId must also be specified. Pass 0 to filter unassigned locations. |
departmentRefId |
int32 | No | No | - | Unique identifier (primary key) of the department to filter by. Pass 0 to filter unassigned departments. |
personRefId |
int32 | No | No | - | Unique identifier (primary key) of the assigned person to filter by. |
customerRefId |
int32 | No | No | - | Unique identifier (primary key) of the assigned customer to filter by. |
EventTypes |
EventType(Enum) | No | Yes | - | Filters assets by the specified event types. Selecting "Custom" includes all user-defined custom events. |
orderBy |
DataField(Enum) | No | No | - | The field to order results by. Default: "ExpiryDate". Allowed values: ExpiryDate, AssetTagId, Description, Brand, Model, SerialNo, PurchaseDate, DateCreated, CreatedBy, WarrantyNotes, WarrantyLength, WarrantyCreatedBy, Cost, PurchaseFrom, InitialCost, SiteName, LocationName, CategoryName, SubCategoryName, DepartmentName, isDepreciable, SalvageValue, AssetLife, DepreciationMethodName, DateAcquired, Status, PersonName, LeaseTo, Reservation, EventDate1, EventDate2, Relation, IsLinked, CurrentCost. |
sortOrder |
SortOrder(Enum) | No | No | - | The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc. |
startDate |
date | No | No | - | The start date for filtering warranty records. Format: "yyyy-MM-dd" Example: 2025-04-01. |
endDate |
date | No | No | - | The end date for filtering warranty records. Format: "yyyy-MM-dd" Example: 2025-04-30. |
dateRangeBy |
DataField(Enum) | No | No | - | Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField or dateRangeByAssetCustomField is provided. Default: "ExpiryDate" Allowed values: ExpiryDate, DateCreated, PurchaseDate, DateAcquired. |
dateRangeByCustomField |
int32 | No | No | - | Defines which warranty custom date field the filter should apply to. Provide the warranty Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided. |
dateRangeByAssetCustomField |
int32 | No | No | - | Defines which asset custom date field the filter should apply to. Provide the asset Custom Field ID to enable this filter, which takes precedence over dateRangeBy and dateRangeByCustomField when set. Requires startDate and endDate to also be provided. |
fetchCustomFields |
boolean | No | No | False | Whether to include custom fields in the result. Default: "false". |
offset |
int32 | No | No | 0 | The number of records to skip before returning results. Default: "0" |
limit |
int32 | No | No | 20 | The maximum number of records to return. Default: "20" Allowed range: 1-100. |
Schema: WarrantyListRequest
Responses:
Retrieves the details of a warranty by its unique identifier (refId).
Production Endpoint:
https://api.assettiger.com/v1/warranties/{refId}
Sandbox Endpoint:
https://api.assettiger.com/sandbox/warranties/{refId}
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) for the warranty (positive integer only). |
fetchCustomFields |
boolean | No | No | False | Indicates whether to include custom fields associated with this warranty (default: false). |
Responses:
Get Warranty Settings.
Production Endpoint:
https://api.assettiger.com/v1/warranties/settings
Sandbox Endpoint:
https://api.assettiger.com/sandbox/warranties/settings
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Responses:
Creates a Asset Warranty using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/warranties/add
Sandbox Endpoint:
https://api.assettiger.com/sandbox/warranties/add
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"assetRefId": 1,
"length": 36,
"expiryDate": "2025-01-01",
"notes": "Warranty Notes",
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: WarrantyRequest
Responses:
Update a warranty using the provided request.
Production Endpoint:
https://api.assettiger.com/v1/warranties/{refId}/update
Sandbox Endpoint:
https://api.assettiger.com/sandbox/warranties/{refId}/update
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Parameters:
| Name | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
refId |
int32 | Yes | No | - | Unique identifier (primary key) of the warranty. Must be a positive integer. |
Request Body:
{
"assetRefId": 1,
"length": 36,
"expiryDate": "2025-01-01",
"notes": "Warranty Notes",
"customFieldRequest": [
{
"customFieldId": 1,
"customFieldValue": "Sample Text"
},
{
"customFieldId": 2,
"customFieldValue": "[email protected]"
}
]
}Schema: WarrantyRequest
Responses:
Deletes a warranty by its unique reference ID, scoped to the asset it belongs to (both refId and assetRefId are required).
Production Endpoint:
https://api.assettiger.com/v1/warranties/delete
Sandbox Endpoint:
https://api.assettiger.com/sandbox/warranties/delete
Headers:
These headers are required when calling this endpoint. Copy the Name into your request header and provide the appropriate value.
| Header | Location | Type | Details |
|---|---|---|---|
Authorization |
header | string |
Enter your access token in the format: Bearer {token}
Example:
Bearer <your_token_here> |
Request Body:
{
"refId": 1,
"assetRefId": 101
}Schema: DeleteWarrantyRequest
Responses: