List results

Last modified: March 06, 2024

This endpoint allows you to list all of your rendered images and PDFs.

GET Endpoint

https://get.renderform.io/api/v2/results

Looking for the v1 endpoint?

Example request

curl --location
     --request GET 'https://get.renderform.io/api/v2/results' \
     --header 'X-API-KEY: <API_KEY>' \
     --header 'Content-Type: application/json'

Pagination

You can paginate the results by using the page and size query parameters.

ParameterTypeDescription
pageintegerThe page number
sizeintegerThe number of results per page (max 50)

Sample response

{
  "content": [
    {
      "identifier": "req-2fbdb726-ca4c-4ec7-853a-0331160a9557",
      "href": "https://cdn.renderform.io/dfa26701ea7ba9e6c1cbff99a2ab81f5378d0e0af7035452e1bc9105ea1f33ae/results/req-2fbdb726-ca4c-4ec7-853a-0331160a9557.jpg",
      "width": 1172,
      "height": 1437,
      "templateName": "Hotel card Airtable",
      "createdAt": "2022-12-12T14:35:08Z"
    }
  ],
  "pageable": {
    "sort": {
      "empty": true,
      "unsorted": true,
      "sorted": false
    },
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 1,
    "unpaged": false,
    "paged": true
  },
  "totalPages": 13102,
  "totalElements": 13102,
  "last": false,
  "size": 1,
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": false
  },
  "numberOfElements": 1,
  "first": true,
  "empty": false
}