This endpoint allows you to list all of your paid requests. It returns records of taken screenshots, and generated images.
This endpoint has been deprecated. Please use List Results v2 instead.
GET Endpoint
https://api.renderform.io/api/v1/requests
Example request
curl
--location
--request GET 'https://api.renderform.io/api/v1/requests' \
--header 'X-API-KEY: <API_KEY>' \
--header 'Content-Type: application/json'
Pagination
You can paginate the results by using the limit
and offset
query parameters.
Parameter | Type | Description |
---|---|---|
limit | integer | The number of records to return. (max 100) |
offset | integer | The number of records to skip. |
Example response
The response contains two entries. The first entry is a screenshot type and the second entry is an image generated based on the template.
[
{
"identifier": "1dDefKaC-58XFhX81sPus1v41SM",
"href": "https://cdn.renderform.io/.../febbd34c-cadf-43e6-926c-5942016aea4e.jpg",
"executeUrl": "https://renderform.io",
"status": "200",
"width": 1366,
"height": 768,
"type": "screenshot",
"createdAt": "2019-09-30T14:00:42"
},
{
"identifier": "old54T8w2TERyZZQSzIcRmiWF4",
"href": "https://cdn.renderform.io/.../78f50cb2-e3ce-4016-a292-0d1c9dae81cb.jpg",
"status": "200",
"width": 1080,
"height": 1080,
"type": "image",
"template": "OvS9eNpSyXpnIo8rxG7oBndtyWs",
"templateName": "My Template",
"changes": "<CHANGES_ARRAY>",
"createdAt": "2019-09-27T19:44:03"
}
]