Some top-level API routes support bulk fetches via "list" API methods. For instance, you can list surveys or survey results. These API methods share a common structure using the page and per_page parameters.
Arguments | |
---|---|
page | The current desired page of results to be returned. Defaults to 1. |
Response Sections | |
---|---|
data | Collection of objects representing the result of the request. |
links | Relevant links that you can directly use to navigate across pages. |
meta | Key information about the results. Fairly self-explanatory. |
{
"data": [
...
],
"links": {
"first": "https://app.voiceform.com/v1/...&page=1",
"last": "https://app.voiceform.com/v1/...&page=5",
"prev": null,
"next": "https://app.voiceform.com/v1/...&page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 5,
"path": "https://app.voiceform.com/v1/...",
"per_page": "50",
"to": 50,
"total": 250
}
}