Retrieve a list of sections#
Deprecated
This endpoint is deprecated and may be removed in a future release.
This endpoint was deprecated on 2026-02-12.
It is scheduled for sunset on 2027-01-31.
Description#
Returns a paginated list of PrototypeSections.
GET /prototype/platform/documents/{documentId}/sections
Required OAuth Scopes
file:read
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
false |
Version of the API (2022-01-01) |
documentId |
path |
string |
true |
The unique identifier of the document |
$revision |
query |
string |
false |
Returns resources at a specific revision |
$maxpagesize |
query |
integer |
false |
The maximum number of results to retrieve |
$next |
query |
string |
false |
Pagination cursor for next set of results. |
Code Samples#
curl -X GET https://api.app.wdesk.com/prototype/platform/documents/{documentId}/sections \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2022-01-01'
http GET https://api.app.wdesk.com/prototype/platform/documents/{documentId}/sections \
X-Version:2022-01-01 \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/prototype/platform/documents/{documentId}/sections" \
--output-document - \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2022-01-01'
import requests
headers = {
'X-Version': '2022-01-01',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.app.wdesk.com/prototype/platform/documents/{documentId}/sections', headers = headers)
print(r.json())
Returns#
200 - OK#
Returns a JSON object with data and @nextLink properties. data contains a list of Section objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.
400 - Bad Request#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
403 - Forbidden#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
404 - Not Found#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
409 - Conflict#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
429 - Too Many Requests#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
500 - Internal Server Error#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Example Responses#
{
"@nextLink": "<opaque_url>",
"data": [
{
"body": {
"location": "<opaque_url>",
"revision": "2c6438ab454db9bc",
"richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
},
"children": [
{
"id": "a8b3adb687644b27fafcb3a9875f0f0d_34",
"name": "Subsection"
}
],
"footers": {
"even": null,
"first": null,
"last": null,
"odd": {
"location": "<opaque_url>",
"revision": "2c6438ab454db9bc",
"richText": "WA1BRU1FTqIQlnLaJGpz0ev9BK2V6zfFJTqIQlnLaJGpz0ev9BK2V6zfFNTf11ymDudGJfgVT99BTOUAbA"
}
},
"headers": {
"even": null,
"first": null,
"last": null,
"odd": {
"location": "<opaque_url>",
"revision": "2c6438ab454db9bc",
"richText": "WA15fXV99dpoorkriHFJL6dPHE11C99clxdpoorkriHFJL6dPHE11C99cl1dzfqg99I8GEl9BEmZubioYbgg"
}
},
"id": "a8b3adb687644b27fafcb3a9875f0f0d_13",
"index": 0,
"lock": null,
"name": "Section",
"nonPrinting": false,
"parent": null,
"properties": {
"background": null,
"edgarKeepTogether": false,
"exhibit": false,
"footer": {
"alternatingPage": false,
"differentFirstPage": false,
"differentLastPage": false,
"margin": null,
"matchSectionMargins": true,
"positionFromBottom": null,
"sameAsPrevious": false
},
"header": {
"alternatingPage": false,
"differentFirstPage": false,
"differentLastPage": false,
"margin": null,
"matchSectionMargins": true,
"positionFromTop": null,
"sameAsPrevious": false
},
"margins": {
"bottom": null,
"left": null,
"right": null,
"top": null
},
"pageBreakBefore": false,
"pageDimensions": null,
"pageNumber": {
"reset": false,
"startAt": 1
},
"restartFootnoteNumbering": false,
"trackChanges": false
},
"revision": "5B3C4D7B"
}
]
}
{
"code": "400BadRequest",
"message": "The request was unacceptable, often due to a missing or invalid parameter"
}
{
"code": "401Unauthorized",
"message": "No valid API token provided"
}
{
"code": "403Forbidden",
"message": "The API token does not have permissions to perform the request"
}
{
"code": "404NotFound",
"message": "The requested resource could not be found"
}
{
"code": "409Conflict",
"message": "The request conflicts with another request"
}
{
"code": "429TooManyRequests",
"message": "Too many requests have been made against the API in too short a time"
}
{
"code": "500InternalServerError",
"message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
{
"code": "503ServiceUnavailable",
"message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}