Retrieve rich text paragraphs

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 ParagraphsListResult for a rich text object, given its id.

GET /prototype/platform/content/richText/{richTextId}/paragraphs

Required OAuth Scopes

file:read

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
richTextId	path	string	true	The unique identifier of the rich text content
$maxpagesize	query	integer	false	The maximum number of results to retrieve
$next	query	string	false	Pagination cursor for next set of results.
$revision	query	string	false	Returns resources at a specific revision

Code Samples

curl

curl -X GET https://api.app.wdesk.com/prototype/platform/content/richText/{richTextId}/paragraphs \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/prototype/platform/content/richText/{richTextId}/paragraphs \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/prototype/platform/content/richText/{richTextId}/paragraphs" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

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/content/richText/{richTextId}/paragraphs', headers = headers)

print(r.json())

Returns

200 - OK

Returns a ParagraphsListResult object containing details about the requested Paragraph content.

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.

401 - Unauthorized

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.

503 - Service Unavailable

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

200 Response

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "elements": [
        {
          "chart": {
            "dimensions": {
              "height": 240,
              "width": 240
            },
            "length": 10,
            "offset": 10,
            "style": {
              "location": "<opaque_url>",
              "revision": "2B3C4D5E",
              "style": "c3R5bGUta2V5Ol90Ymw",
              "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
            },
            "table": {
              "revision": "24601abc",
              "table": "WA66srK9AtGU3PvTjs4dMCR9B34EoH6LqyloPIRNdxS5Bgs3p199MQzPsA"
            }
          },
          "type": "chart"
        }
      ],
      "format": {
        "bold": true
      },
      "index": 0,
      "properties": {
        "alignment": "justified",
        "endIndent": 240,
        "firstLineIndent": 240,
        "pageBreakBefore": false,
        "startIndent": 240
      },
      "style": {
        "location": "<opaque_url>",
        "revision": "2B3C4D5E",
        "style": "c3R5bGUta2V5Ol90Ymw",
        "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
      }
    }
  ]
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}