You can use the Found Hero API to create, update, list, and remove lost items.
Found Hero currently supports the following packaging boxes. You should pass the value of the selected box while creating the lost item.
Value | Description | Dimension (cm) |
| Letter | 33 x 23 x 3 |
| Flat Box | 33 x 23 x 6 |
| Shoe Box | 40 x 20 x 20 |
| Moving Box | 60 x 40 x 40 |
| Long Box | 100 x 20 x 20 |
We are working on adding support for custom packaging boxes. It will allow users to input the width, height, and depth of the package box.
iPhone X
brand
's model of the lost itemlb
, kg
, oz
, and g
. The default value is kg
. true
or false
value indicating whether the lost item consists of documents only{"status": true,"message": "Lost item created successfully","data": {"owner": {"firstName": "Amina","lastName": "Mankid","email": "amina.mankid@hotmail.com","phone": "+49 175 78452548"},"shipping": {"weightUnit": "kg","isDocument": false,"trackingNumbers": [],"totalPrice": 0,"taxes": 0,"fees": 0,"insurance": 0,"weight": 3.5,"boxType": "moving"},"ownShipment": false,"labelGenerated": false,"archived": false,"language": "en","_id": "5f29dbaf81e97ab3a73e2c69","location": "5f29a6a2af7c9568fe1437f7","identifier": "etxOKQlM5sAx","description": "Macbook Pro","discoveryPlace": "Room #452","discoveryDate": "2020-07-22T00:00:00.000Z","lastEmailSent": "2020-08-04T22:05:35.361Z","notes": "The item seems to be damaged.","brand": "Apple","model": "X Series","color": "Silver","status": "PENDING","activity": [{"_id": "5f29dbaf81e97ab3a73e2c6a","type": "EMAIL_SENT","title": "An email was sent at amina.mankid@hotmail.com to inform the owner about their lost item.","createdAt": "2020-08-04T22:05:35.808Z","updatedAt": "2020-08-04T22:05:35.808Z"}],"storagePlace": "Reception","createdAt": "2020-08-04T22:05:35.381Z","updatedAt": "2020-08-04T22:05:35.810Z"}}
{"status": false,"message": "Item description is required"}
{"status": false,"message": "Location not found"}
{"status": true,"data": {"owner": {"firstName": "Amina","lastName": "Mankid","email": "amina.mankid@hotmail.com","phone": "+49 175 78452548"},"shipping": {"weightUnit": "kg","isDocument": false,"trackingNumbers": [],"totalPrice": 0,"taxes": 0,"fees": 0,"insurance": 0,"weight": 3.5,"boxType": "moving"},"ownShipment": false,"labelGenerated": false,"archived": false,"language": "en","_id": "5f29dbaf81e97ab3a73e2c69","location": {"contact": {"name": "David Backem","email": "david.backem@gmail.com","email2": null,"phone": "+1 (455) 4567-8974"},"pickupTime": {"from": "08:00","to": "14:00"},"storageDuration": 30,"active": true,"_id": "5f29a6a2af7c9568fe1437f7","user": "5f1c11c77431601b2fff7459","name": "Four Seasons Hotel Chicago","permalink": "four-seasons-hotel-chicago-TIqfTF","identifier": "8LiwV5xppI3s","website": "https://www.fourseasons.com/chicago/","type": "hotel","storagePlace": "House Keeping","address1": "120 E. Delaware Place","city": "Chicago","state": "IL","zipCode": "60611","country": "US","createdAt": "2020-08-04T18:19:14.471Z","updatedAt": "2020-08-04T20:47:28.688Z","__v": 0,"address2": null,"description": "#1 hotel in Chicago","latitude": null,"longitude": null,"logoUrl": "https://cdn.joinfoundhero.com/l/38acd909-e623-48e2-8c89-b01f5759afbd.png"},"identifier": "etxOKQlM5sAx","description": "Macbook Pro","discoveryPlace": "Room #452","discoveryDate": "2020-07-22T00:00:00.000Z","lastEmailSent": "2020-08-04T22:05:35.361Z","notes": "The item seems to be damaged.","brand": "Apple","model": "X Series","color": "Silver","status": "PENDING","activity": [{"_id": "5f29dbaf81e97ab3a73e2c6a","type": "EMAIL_SENT","title": "An email was sent at amina.mankid@hotmail.com to inform the owner about their lost item.","createdAt": "2020-08-04T22:05:35.808Z","updatedAt": "2020-08-04T22:05:35.808Z"}],"storagePlace": "Reception","createdAt": "2020-08-04T22:05:35.381Z","updatedAt": "2020-08-04T22:05:35.810Z"}}
{"status": false,"message": "Item not found"}
iPhone X
brand
's model of the lost itemlb
, kg
, oz
, and g
. The default value is kg
. true
or false
value indicating whether the lost item consists of documents only{"status": true,"message": "Lost item is updated","data": {"owner": {"firstName": "Amina","lastName": "Mankid","email": "amina.mankid@hotmail.com","phone": "+49 175 78452548"},"shipping": {"weightUnit": "kg","isDocument": false,"trackingNumbers": [],"totalPrice": 0,"taxes": 0,"fees": 0,"insurance": 0,"weight": 3.5,"boxType": "flat"},"ownShipment": false,"labelGenerated": false,"archived": false,"language": "en","_id": "5f29dbaf81e97ab3a73e2c69","location": {"contact": {"name": "David Backem","email": "david.backem@gmail.com","email2": null,"phone": "+1 (455) 4567-8974"},"pickupTime": {"from": "08:00","to": "14:00"},"storageDuration": 30,"active": true,"_id": "5f29a6a2af7c9568fe1437f7","user": "5f1c11c77431601b2fff7459","name": "Four Seasons Hotel Chicago","permalink": "four-seasons-hotel-chicago-TIqfTF","identifier": "8LiwV5xppI3s","website": "https://www.fourseasons.com/chicago/","type": "hotel","storagePlace": "House Keeping","address1": "120 E. Delaware Place","city": "Chicago","state": "IL","zipCode": "60611","country": "US","createdAt": "2020-08-04T18:19:14.471Z","updatedAt": "2020-08-04T20:47:28.688Z","__v": 0,"address2": null,"description": "#1 hotel in Chicago","latitude": null,"longitude": null,"logoUrl": "https://cdn.joinfoundhero.com/l/38acd909-e623-48e2-8c89-b01f5759afbd.png"},"identifier": "etxOKQlM5sAx","description": "Macbook Pro 2020","discoveryPlace": "Room #452","discoveryDate": "2020-08-02T00:00:00.000Z","lastEmailSent": "2020-08-04T22:05:35.361Z","notes": "The item seems to be damaged.","brand": "Apple","model": "X Series","color": "Silver","status": "PENDING","activity": [{"_id": "5f29dbaf81e97ab3a73e2c6a","type": "EMAIL_SENT","title": "An email was sent at amina.mankid@hotmail.com to inform the owner about their lost item.","createdAt": "2020-08-04T22:05:35.808Z","updatedAt": "2020-08-04T22:05:35.808Z"}],"storagePlace": "Reception","createdAt": "2020-08-04T22:05:35.381Z","updatedAt": "2020-08-04T23:23:29.390Z","__v": 1}}
{"status": false,"message": "Item description is required"}
{"status": false,"message": "Item not found"}
term
to search lost items by their descriptions and guest information.
This method also supports pagination. You can use limit
and page
query parameters to control pagination.
10
and 100
. The default value is 10
.1
.{"status": true,"data": {"items": [{"owner": {"firstName": "Amina","lastName": "Mankid","email": "amina.mankid@hotmail.com","phone": "+49 175 78452548"},"shipping": {"weightUnit": "kg","isDocument": false,"trackingNumbers": [],"totalPrice": 0,"taxes": 0,"fees": 0,"insurance": 0,"weight": 3.5,"boxType": "flat"},"ownShipment": false,"labelGenerated": false,"archived": false,"language": "en","_id": "5f29dbaf81e97ab3a73e2c69","location": "5f29a6a2af7c9568fe1437f7","identifier": "etxOKQlM5sAx","description": "Macbook Pro 2020","discoveryPlace": "Room #452","discoveryDate": "2020-08-02T00:00:00.000Z","lastEmailSent": "2020-08-04T22:05:35.361Z","notes": "The item seems to be damaged.","brand": "Apple","model": "X Series","color": "Silver","status": "PENDING","activity": [{"_id": "5f29dbaf81e97ab3a73e2c6a","type": "EMAIL_SENT","title": "An email was sent at amina.mankid@hotmail.com to inform the owner about their lost item.","createdAt": "2020-08-04T22:05:35.808Z","updatedAt": "2020-08-04T22:05:35.808Z"}],"storagePlace": "Reception","createdAt": "2020-08-04T22:05:35.381Z","updatedAt": "2020-08-04T23:23:29.390Z"}],"page": 1,"limit": 10,"count": 1,"totalPages": 1,"hasMore": false}}
{"status": false,"message": "Location not found"}
{"status": true,"message": "Item deleted successfully"}
{"status": false,"message": "Item not found"}
Content-Type
header to multipart/form-data
.{"status": true,"message": "Image is uploaded successfully","data": "https://cdn.joinfoundhero.com/i/b4ea1133-af0c-4559-300a-120fe08f421b.png"}
{"status": false,"message": "File size must not exceed 10MB"}