Device Rescue

## Sections
• [Introduction](https://app.theneo.io/devicerescue/api-docs/introduction.md): 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.
• [Warehousing (IT Closet)](https://app.theneo.io/devicerescue/api-docs/company-assets-it-closet.md): Manage company-owned assets stored in your warehouse (IT Closet). Includes endpoints for listing available inventory, and shipping devices.
  • [List Warehouse Assets](https://app.theneo.io/devicerescue/api-docs/company-assets-it-closet/list-warehouse-assets.md): 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.
  • [Ship & Assign Assets](https://app.theneo.io/devicerescue/api-docs/company-assets-it-closet/ship-and-assign-assets.md): 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.
• [Company Assets](https://app.theneo.io/devicerescue/api-docs/company-assets.md): 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.
  • [List Company Assets](https://app.theneo.io/devicerescue/api-docs/company-assets/list-company-assets.md): 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.
  • [Start Retrieval for Assigned Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/start-retrieval-for-assigned-asset.md): 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.
  • [Create Company Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/create-company-asset.md): 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.
  • [Get Asset Details](https://app.theneo.io/devicerescue/api-docs/company-assets/get-asset-details.md): 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.
  • [Update Company Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/update-company-asset.md): Updates one or more fields on an existing company asset. Only include the fields you wish to modify—any omitted fields will remain unchanged.
  • [Retire Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/retire-asset.md): Retires an asset if it is unassigned and not currently in the warehouse (IT Closet). Optionally records a sold price in cents.
  • [Reactivate Retired Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/reactivate-retired-asset.md): Reactivates a previously retired asset, making it available for assignment again—only allowed if your company is within its active asset limit.
  • [Delete Company Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/delete-company-asset.md): 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).
  • [Asset Options](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-options.md): Provides reference data used when managing company assets, such as available brands, categories, and types.
    • [Get Asset Types](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-options/get-asset-types.md): Returns a list of all available asset types, sorted alphabetically with "Other" at the bottom.
    • [Get Asset Brands](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-options/get-asset-brands.md): Returns a list of all available asset brands, sorted alphabetically with "Other" at the bottom.
    • [Get Asset Categories](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-options/get-asset-categories.md): Returns a list of all available asset categories, sorted alphabetically with "Other" at the bottom.
  • [Documents](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-documents.md): Manage documents attached to company-owned assets. Includes uploading, and removing files such as invoices, receipts, or compliance records.
    • [List Asset Documents](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-documents/list-asset-documents.md): Returns a paginated list of all documents attached to the given asset.
    • [Delete Asset Document](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-documents/delete-asset-document.md): Deletes a specific document attached to an asset. Condition reports build by Device Rescue cannot be deleted.
  • [Notes](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-notes.md): Manage internal notes associated with company assets. Use notes to track status updates, history, or other asset-related context.
    • [List Asset Notes](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-notes/list-asset-notes.md): Returns a paginated list of all notes attached to the given asset.
    • [Add Note to Asset](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-notes/add-note-to-asset.md): Adds a new note to a specific asset. Notes are visible in the asset history and useful for tracking asset-related activity.
    • [Delete Asset Note](https://app.theneo.io/devicerescue/api-docs/company-assets/company-assets-notes/delete-asset-note.md): Deletes a specific note from an asset. System-generated notes and those from Device Rescue staff cannot be deleted.
• [Team Members](https://app.theneo.io/devicerescue/api-docs/team-members.md): Manage your company’s employees. Includes creating profiles, assigning devices, updating details, and handling onboarding/offboarding.
  • [List Team Members](https://app.theneo.io/devicerescue/api-docs/team-members/list-team-members.md): 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.
  • [Create Team Member](https://app.theneo.io/devicerescue/api-docs/team-members/create-team-member.md): 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.
  • [Get Team Member](https://app.theneo.io/devicerescue/api-docs/team-members/get-team-member.md): Retrieves a specific team member in your company account by their ID. Useful for displaying detailed information such as their contact, branch, and address.
  • [Update Team Member](https://app.theneo.io/devicerescue/api-docs/team-members/update-team-member.md): 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.
  • [Offboard Team Member](https://app.theneo.io/devicerescue/api-docs/team-members/offboard-team-member.md): 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.
  • [Re-Onboard Team Member](https://app.theneo.io/devicerescue/api-docs/team-members/re-onboard-team-member.md): Re-onboards a previously terminated team member by setting their status back to "active". You can optionally provide a new start date.
  • [Delete Team Member](https://app.theneo.io/devicerescue/api-docs/team-members/delete-team-member.md): 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.
  • [Assignments](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-assignments.md): Assign and return devices for employees in your company. Includes viewing current and past device assignments.
    • [Assign a Device](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-assignments/assign-a-device.md): Assigns an available asset from your inventory to the specified team member. The asset must not currently be assigned or stored in the warehouse (IT Closet). A note can optionally be included to describe the context of the assignment (e.g., accessories, condition).
    • [Return Assigned Device](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-assignments/return-assigned-device.md): Marks a device as returned from the specified team member. This endpoint updates the asset assignment and sets the returned date. Optionally, include a note about the return condition.
    • [Current Assigned Devices](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-assignments/current-assigned-devices.md): Returns a paginated list of all active (not yet returned) device assignments for a specific team member. Use this to view which devices are currently in use by the employee.
    • [Past Device Assignments](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-assignments/past-device-assignments.md): Returns a paginated list of device assignments that have been returned by the specified team member. Useful for historical tracking or auditing purposes.
  • [Documents](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-documents.md): Manage documents attached to your company’s team members. Includes viewing and permanently deleting uploaded files such as agreements, ID scans, or onboarding forms.
    • [List Team Member Documents](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-documents/list-team-member-documents.md): Returns a paginated list of documents attached to the specified team member. Each document includes file metadata, who uploaded it, and when.
    • [Delete Team Member Document](https://app.theneo.io/devicerescue/api-docs/team-members/team-member-documents/delete-team-member-document.md): Deletes a document previously uploaded to the specified team member. This action is permanent and cannot be undone.
• [Office Branches](https://app.theneo.io/devicerescue/api-docs/office-branches.md): Manage your company’s physical office locations. Includes creating, updating, and deleting branches.
  • [List Office Branches](https://app.theneo.io/devicerescue/api-docs/office-branches/list-office-branches.md): Returns a paginated list of all office branches. Each branch includes its address, contact details, and shipping preferences.
  • [Create Office Branch](https://app.theneo.io/devicerescue/api-docs/office-branches/create-office-branch.md): Creates a new office branch with a friendly name and contact/address information. This address can be used for shipping devices or assigning assets.
  • [Get Office Branch](https://app.theneo.io/devicerescue/api-docs/office-branches/get-office-branch.md): Returns details for a specific office branch, including contact information and shipping preferences.
  • [Update Office Branch](https://app.theneo.io/devicerescue/api-docs/office-branches/update-office-branch.md): Updates an existing office branch’s name, address, or shipping notification preferences. Only provide the fields you want to update.
  • [Delete Office Branch](https://app.theneo.io/devicerescue/api-docs/office-branches/delete-office-branch.md): Deletes an office branch. Cannot delete if it has active asset assignments.
  • [Assignments](https://app.theneo.io/devicerescue/api-docs/office-branches/office-branch-assignments.md): View and manage asset assignments at specific office branches. Includes assigning devices, returning them, and reviewing current or past assignments.
    • [List Branch Team Members](https://app.theneo.io/devicerescue/api-docs/office-branches/office-branch-assignments/list-branch-team-members.md): Returns a paginated list of all team members currently assigned to the specified office branch. Includes team member details and branch information.
    • [Get Current Branch Assignments](https://app.theneo.io/devicerescue/api-docs/office-branches/office-branch-assignments/get-current-branch-assignments.md): Returns a paginated list of active (not yet returned) asset assignments for a specific office branch.
    • [Get Past Branch Assignments](https://app.theneo.io/devicerescue/api-docs/office-branches/office-branch-assignments/get-past-branch-assignments.md): Returns a paginated list of previously returned asset assignments for a specific office branch.
    • [Assign Asset to Branch](https://app.theneo.io/devicerescue/api-docs/office-branches/office-branch-assignments/assign-asset-to-branch.md): Assigns an available asset to a specific office branch. The asset must not be currently assigned or in the warehouse (IT Closet). Useful for tracking which branch holds which devices.
    • [Return Asset from Branch](https://app.theneo.io/devicerescue/api-docs/office-branches/office-branch-assignments/return-asset-from-branch.md): Marks an asset as returned from the specified office branch. This is used when an assigned device is no longer needed and should be returned to inventory.
• [Retrieval Kits](https://app.theneo.io/devicerescue/api-docs/retrieval-kits.md): Create and manage retrieval kit orders for team members or office branches. This includes placing new orders, tracking shipping status, and viewing retrieval history.
  • [Get All Retrieval History](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/get-all-retrieval-history.md): Returns a paginated list of your past Retrieval Kit orders, including shipping status updates when labels have been generated.
  • [Create a Retrieval Kit Order](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/create-a-retrieval-kit-order.md): 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.
  • [Get Retrieval Kit Details](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/get-retrieval-details.md): Returns detailed information about a specific Retrieval Kit order, including addresses, shipping status, product details, and associated instruction note if provided.
  • [Update retrieval details](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/update-retrieval-details.md): 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.
  • [Kit Options](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-kit-options.md): Provides available setup options for Retrieval Kits, including shipping carriers, insurance rates, and country-specific product pricing and availability.
    • [Get Retrieval Kit Options](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-kit-options/fetch-all-available-retrieval-products.md): Returns a list of available retrieval kit products, including supported carrier options and current pricing based on country.
    • [Get Insurance Options](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-kit-options/fetch-all-available-insurance-rates.md): Returns a list of all insurance coverage options available for Retrieval Kits and warehouse-dispatched shipments. Each option includes the price and the total coverage amount.
  • [Retrieval Notes](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-notes.md): Manage internal notes and instructional messages attached to Retrieval Kit orders. Useful for providing special handling instructions or tracking internal comments.
    • [Create a Retrieval Note](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-notes/create-a-retrieval-note.md): Create a note for a specific Retrieval Kit ID.
    • [Get Retrieval Notes](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-notes/get-retrieval-notes.md): Returns retrieval notes for a specific Retrieval Kit ID.
    • [Delete a Retrieval Note](https://app.theneo.io/devicerescue/api-docs/retrieval-kits/retrieval-kits-notes/delete-a-retrieval-note.md): Deletes a note belonging to the Retrieval Kit.
• [Delivery Addresses](https://app.theneo.io/devicerescue/api-docs/company-settings-addresses.md): 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.
  • [List Delivery Addresses](https://app.theneo.io/devicerescue/api-docs/company-settings-addresses/list-delivery-addresses.md): View all saved delivery addresses for your company. Reuse them when creating retrieval kit orders to avoid retyping shipping info each time.
  • [Create Delivery Address](https://app.theneo.io/devicerescue/api-docs/company-settings-addresses/create-delivery-address.md): 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.
  • [Update Delivery Address](https://app.theneo.io/devicerescue/api-docs/company-settings-addresses/update-delivery-address.md): Updates a delivery address for the authenticated company. Only the fields provided will be updated.
  • [Delete Delivery Address](https://app.theneo.io/devicerescue/api-docs/company-settings-addresses/delete-delivery-address.md): Deletes a saved delivery address.