GET
/
rentals
/
status
/
{status}
List rentals with a specific status
curl --request GET \
  --url https://api.gputrader.io/v1/rentals/status/{status} \
  --header 'X-API-Key: <api-key>'
[
  {
    "rentalId": "<string>",
    "listing": {},
    "userId": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "name": "My Instance",
    "status": "ACTIVE",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isSeed": true
  }
]

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
status
string
required

Rental status to filter by

Query Parameters

​
limit
number

Maximum number of results to return (max 25)

​
lastEvaluatedKey
string

Key for pagination

Response

200
application/json

Successfully retrieved rentals

The response is of type object[].