REST API documentation
Use our API to automatically initiate device transfers and monitor their progress until completion. Available in Enterprise & Custom plans only.
Why an API integration?
Do you want to automate the process of recovering devices from your employees? Do you not use any of the HR systems ReReady is integrated with? Do you have in-house technical capability? Then you can build your own API integration, and enjoy automated device deployments and returns.
What can be done through the API?
You can use the API to:
- Create a device transfer to start a deployment or return.
- View a device transfer to monitor progress over time.
Who has access to the API?
Only Enterprise customers have access to the API. To learn more, see What is an Enterprise account?
Overview
The ReReady API is a RESTful JSON API. That means it is designed to:
- follow standard RESTful conventions
- accept JSON-formatted request payloads
- return JSON-formatted response payloads
Enable API access
Only Enterprise users can use the API. To enable your organization's Enterprise plan:
- Log in to your ReReady account (or open a free account).
- Click the "Settings" button at the top.
- If you haven't already, click "Enable Enterprise plan".
Authentication
Every API request must include an Authorization header containing your API key as a Token:
Authorization: Token YOUR-API-KEY-HERE
To view your API keys:
- Log in to your ReReady account (or open a free account).
- Click the "Settings" button at the top.
- Click the "Manage API keys" button.
Create a device transfer
Create a new device transfer (deployment or return). ReReady will send a sturdy box containing a prepaid shipping label so the device can be deployed/returned.
| Method |
POST
|
|---|---|
| URL |
https://www.reready.co/api/v1/device_transfers
|
| JSON parameters |
|
| Example JSON request |
{
"organization_address": {
"organization_name": "Maas Biolabs",
"attention_name": "Human Resources",
"line_1": "555 Nondescript Road",
"city": "Maricopa",
"state_code": "AZ",
"postal_code": "85139",
"country_code": "US"
},
"device_type": "laptop",
"employee_address": {
"person_name": "Christopher Mitchell",
"line_1": "404 Hidden Spring Lane",
"city": "Pittsburgh",
"state_code": "PA",
"postal_code": "15238",
"country_code": "US"
}
}
|
| Example JSON response |
{
"box_shipment": null,
"box_shipment_carrier_code_required": null,
"box_shipment_rush": false,
"box_shipment_waived": false,
"organization_address": {
"organization_name": null,
"attention_name": "Human Resources",
"line_1": "555 Nondescript Road",
"line_2": null,
"city": "Maricopa",
"state_code": "AZ",
"postal_code": "85139",
"country_code": "US",
"notification_emails": []
},
"created_at": "2026-04-30T09:19:36.188Z",
"device_condition": null,
"device_make": null,
"device_model": null,
"device_serial_number": null,
"device_shipment": null,
"device_shipment_carrier_code_required": null,
"device_shipment_insured_amount": 0,
"device_shipment_pickup_scheduling": null,
"device_shipment_rush": false,
"device_type": "laptop",
"employee_address": {
"person_name": "Christopher Mitchell",
"line_1": "404 Hidden Spring Lane",
"line_2": null,
"city": "Pittsburgh",
"state_code": "PA",
"postal_code": "15238",
"country_code": "US",
"notification_emails": []
},
"id": "e753bfe9-55f0-4fb5-8391-23c4187da14a",
"object": "DeviceTransfer",
"payments": [],
"plan_code": null,
"state": "pending_box_shipment",
"ticket_reference": null,
"type": "return",
"user_email": "hr@example.com"
}
|
View a device transfer
View an existing device transfer. This is how to check the status of a device transfer.
| Method |
GET
|
|---|---|
| URL |
https://www.reready.co/api/v1/device_transfers/DEVICE-RETURN-UUID-HERE
|
| JSON parameters |
None |
| Example JSON request |
{}
|
| Example JSON response |
{
"box_shipment": {
"carrier_code": "USPS",
"delivered_at": null,
"shipped_at": "2026-04-30T09:19:36.198Z",
"state": "in_transit",
"tracking_id": "11111111111111111111",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=11111111111111111111",
"updated_at": "2026-04-30T09:19:36.198Z"
},
"box_shipment_carrier_code_required": null,
"box_shipment_rush": false,
"box_shipment_waived": false,
"organization_address": {
"organization_name": null,
"attention_name": "Human Resources",
"line_1": "555 Nondescript Road",
"line_2": null,
"city": "Maricopa",
"state_code": "AZ",
"postal_code": "85139",
"country_code": "US",
"notification_emails": []
},
"created_at": "2026-04-30T09:19:36.197Z",
"device_condition": null,
"device_make": null,
"device_model": null,
"device_serial_number": null,
"device_shipment": {
"carrier_code": "FedEx",
"delivered_at": null,
"shipped_at": null,
"state": "pre_transit",
"tracking_id": "222222222222",
"tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=222222222222&cntry_code=us",
"updated_at": "2026-04-30T09:19:36.198Z"
},
"device_shipment_carrier_code_required": null,
"device_shipment_insured_amount": 0,
"device_shipment_pickup_scheduling": null,
"device_shipment_rush": false,
"device_type": "laptop",
"employee_address": {
"person_name": "Christopher Mitchell",
"line_1": "404 Hidden Spring Lane",
"line_2": null,
"city": "Pittsburgh",
"state_code": "PA",
"postal_code": "15238",
"country_code": "US",
"notification_emails": []
},
"id": "c3e1af56-e321-4ff5-91ad-cc1eb5ea300f",
"object": "DeviceTransfer",
"payments": [
{
"amount_cents": 8500,
"created_at": "2026-04-30T09:19:36.204Z",
"refunded_amount_cents": 0,
"state": null
}
],
"plan_code": null,
"state": "pending_box_shipment",
"ticket_reference": null,
"type": "return",
"user_email": "hr@example.com"
}
|