Requests
The Found Hero API allows you to programmatically manage your requests. A location is a lost item request where a guest claim that he lost an item in a specific location
Available requests status
Status
INCOMPLETE
PENDING
MATCHED
REJECTED
Retrieve a Request
GET
https://api.joinfoundhero.com/v1/locations/:lid/requests/:id
Retrieves the details of a request that has previously been created. Supply lid
that is the unique ID of location and id
that is the id of the request
Path Parameters
lid
string
The unique location ID
id
string
The unique request ID
Retrieve all requests
GET
https://api.joinfoundhero.com/v1/locations/:lid/requests
Retrieve all requests created previously. By default, this method returns a set of top 10 requests.
This method also supports pagination. You can use limit
and page
query parameters to control pagination.
Path Parameters
lid
string
The unique location ID
Query Parameters
page
integer
The current page number. the default value is 1
limit
integer
the number of results per page. The value must be between 10
and 100
. The default value is 10
.
Update Request Status
PUT
https://api.joinfoundhero.com/v1/locations/:lid/requests/:id/update-status
Using this endpoint you can accept/reject a request by sending a body parameters type
.
Path Parameters
id
string
The unique request ID
lid
string
The unique location ID
Request Body
type
string
reject
or accept
Create new lost item request
POST
https://api.joinfoundhero.com/v1/locations/:lid/requests
Path Parameters
lid
string
The unique location ID
Request Body
proof
string
Describe why this item is yours
owner
object
an object containing : firstName
lastName
email
phone
checkoutDate
string
Request lost date
lostPlace
string
Request last known place
description
string
Request description
Last updated