Device Rescue

Welcome to the API documentation for Device Rescue. Our API provides a robust, secure, and efficient way to interact with endpoints to manage your account, submit retrieval requests, and more.

Introduction

Manage company-owned assets stored in your warehouse (IT Closet). Includes endpoints for listing available inventory, and shipping devices.

Warehousing (IT Closet)

Returns a paginated list of company-owned assets that are currently stored in the warehouse (IT Closet). Use this endpoint to view available inventory for shipping and assignment.

List Warehouse Assets

Prepares a shipment of in-warehouse assets to either a Team Member or an Office Branch. This endpoint creates a warehouse shipment and assigns the assets once shipped.

Ship & Assign Assets

Manage your organization's physical assets such as laptops, phones, and other equipment. Includes endpoints for listing, retrieving, creating, updating, deleting, and tracking asset assignments.

Company Assets

Returns a paginated list of all assets under your account. This includes assigned and unassigned devices such as laptops, phones, tablets, and more. Use this endpoint to view, filter, or manage company-owned equipment.

List Company Assets

Creates a Retrieval Kit order for an assigned asset. The asset must be assigned to a Team Member or Office Branch and must be a supported device type such as a laptop, tablet, or cell phone.

Start Retrieval for Assigned Asset

Creates a new asset record under your company account. This includes asset details such as type, serial number, brand, status, and optional assignment or warehouse info. Use this endpoint to add new inventory for tracking and lifecycle management.

Create Company Asset

Returns detailed information about a specific asset owned by your company. Includes metadata such as asset type, brand, serial number, status, assignment history, and location if applicable.

Get Asset Details

Updates one or more fields on an existing company asset. Only include the fields you wish to modify—any omitted fields will remain unchanged.

Update Company Asset

Retires an asset if it is unassigned and not currently in the warehouse (IT Closet). Optionally records a sold price in cents.

Retire Asset

Reactivates a previously retired asset, making it available for assignment again—only allowed if your company is within its active asset limit.

Reactivate Retired Asset

Deletes a company asset, but only if it is not currently assigned to a team member, office branch, or stored at the warehouse (IT Closet).

Delete Company Asset

Provides reference data used when managing company assets, such as available brands, categories, and types.

Asset Options

Manage documents attached to company-owned assets. Includes uploading, and removing files such as invoices, receipts, or compliance records.

Documents

Manage internal notes associated with company assets. Use notes to track status updates, history, or other asset-related context.

Notes

Manage your company’s employees. Includes creating profiles, assigning devices, updating details, and handling onboarding/offboarding.

Team Members

Returns a paginated list of all team members in your company account. Use this endpoint to display or manage employees who have been added through the API or web portal. Each result includes contact info, address details, status, and branch assignment if applicable.

List Team Members

Registers a new team member to your company. The request must include their role, start date, and a valid residential mailing address. Optionally, you can assign them to a branch.

Create Team Member

Retrieves a specific team member in your company account by their ID. Useful for displaying detailed information such as their contact, branch, and address.

Get Team Member

Update the details of an existing team member in your company. Only include the fields you want to update or nullify — all parameters are optional unless specified.

Update Team Member

Terminates a team member by updating their status to "terminated". A valid termination date is required and must be after the team member’s start date.

Offboard Team Member

Re-onboards a previously terminated team member by setting their status back to "active". You can optionally provide a new start date.

Re-Onboard Team Member

Deletes a team member from your company account. This action is only allowed if the team member has no active (unreturned) device assignments. All historical device assignment records for this team member will also be permanently removed.

Delete Team Member

Assign and return devices for employees in your company. Includes viewing current and past device assignments.

Assignments

Manage documents attached to your company’s team members. Includes viewing and permanently deleting uploaded files such as agreements, ID scans, or onboarding forms.

Manage your company’s physical office locations. Includes creating, updating, and deleting branches.

Office Branches

Returns a paginated list of all office branches. Each branch includes its address, contact details, and shipping preferences.

List Office Branches

Creates a new office branch with a friendly name and contact/address information. This address can be used for shipping devices or assigning assets.

Create Office Branch

Returns details for a specific office branch, including contact information and shipping preferences.

Get Office Branch

Updates an existing office branch’s name, address, or shipping notification preferences. Only provide the fields you want to update.

Update Office Branch

Deletes an office branch. Cannot delete if it has active asset assignments.

Delete Office Branch

View and manage asset assignments at specific office branches. Includes assigning devices, returning them, and reviewing current or past assignments.

Create and manage retrieval kit orders for team members or office branches. This includes placing new orders, tracking shipping status, and viewing retrieval history.

Retrieval Kits

Returns a paginated list of your past Retrieval Kit orders, including shipping status updates when labels have been generated.

Get All Retrieval History

Creates a new Retrieval Kit order for the authenticated company. The origin ("retrieving from") address can be manually specified or derived by providing a `team_member_id` or `branch_id`. The destination ("returning to") address can also be manually specified, selected from a saved `company_address_id`, or set to use the warehouse address by passing `send_to_warehouse: true` (requires Warehousing Add-on). If the company has Net Terms enabled, the order will be invoiced. Otherwise, the primary payment method on file will be charged immediately.

Create a Retrieval Kit Order

Returns detailed information about a specific Retrieval Kit order, including addresses, shipping status, product details, and associated instruction note if provided.

Get Retrieval Kit Details

Updates the retrieving from and delivering to addresses for a retrieval order. This action is only permitted if the retrieval has not yet been processed or shipped.

Update retrieval details

Provides available setup options for Retrieval Kits, including shipping carriers, insurance rates, and country-specific product pricing and availability.

Kit Options

Manage internal notes and instructional messages attached to Retrieval Kit orders. Useful for providing special handling instructions or tracking internal comments.

Retrieval Notes

Manage your company’s saved delivery addresses. Includes creating, updating, and deleting addresses used for retrieving Retrieval Kits from departing Team Members or from your Office Branches.

Delivery Addresses

View all saved delivery addresses for your company. Reuse them when creating retrieval kit orders to avoid retyping shipping info each time.

List Delivery Addresses

Creates a new delivery address for your company. These saved addresses can be reused when sending retrieval kits or shipments, reducing the need to re-enter shipping details manually.

Create Delivery Address

Updates a delivery address for the authenticated company. Only the fields provided will be updated.

Update Delivery Address

Delete Delivery Address

Default

Production

Endpoint

Testing

Welcome to the API documentation for Device Rescue. Our API provides a robust, secure, and efficient way to interact with endpoints to manage your account, submit retrieval requests, and more.

Manage company-owned assets stored in your warehouse (IT Closet). Includes endpoints for listing available inventory, and shipping devices.

Manage your organization&apos;s physical assets such as laptops, phones, and other equipment. Includes endpoints for listing, retrieving, creating, updating, deleting, and tracking asset assignments.

page

data

links

message

Not Found

carrier_option_id

insurance_option_id

Optional: Address ID to deliver to. Required if not providing a delivering_to address.

company_address_id

Optional: Store this returned device at our warehouse instead of delivering it back to your company.

send_to_warehouse

Optional: Instruction note for the Retrieval Kit order.

instruction_note

Delivering To Address. Required if no company_address_id is provided or send_to_warehouse is not true.

delivering_to

name

description

asset_tag

serial_number

purchase_price

purchase_date

eol_date

type_id

brand_id

category_id

Forbidden

errors

Returns detailed information about a specific asset owned by your company. Includes metadata such as asset type, brand, serial number, status, assignment history, and location if applicable.

sold_price

Optional sold price in cents (e.g., 100000 = $1000.00).

Asset cannot be retired due to current status or location.

Conflict

Validation error (e.g., invalid sold_price).

Asset cannot be deleted due to active assignments or warehouse presence.

Returns a paginated list of all notes attached to the given asset.

List Asset Notes

Adds a new note to a specific asset. Notes are visible in the asset history and useful for tracking asset-related activity.

Add Note to Asset

The content of the note to be saved on the asset.

note

Created

Validation error (e.g., note is missing or too long).

Deletes a specific note from an asset. System-generated notes and those from Device Rescue staff cannot be deleted.

Delete Asset Note

noteId

Internal Server Error

Manage your company’s employees. Includes creating profiles, assigning devices, updating details, and handling onboarding/offboarding.

Manage your company’s physical office locations. Includes creating, updating, and deleting branches.

Create and manage retrieval kit orders for team members or office branches. This includes placing new orders, tracking shipping status, and viewing retrieval history.

Manage your company’s saved delivery addresses. Includes creating, updating, and deleting addresses used for retrieving Retrieval Kits from departing Team Members or from your Office Branches.

Sections