Retrieve a list of XbrlProfiles by a Document ID

Description

Returns a paginated list of XbrlProfiles using a Document ID.

Responds with a bad request error for the following scenarios:

• The $filter query parameter uses an unsupported filter.

• The $maxpagesize query parameter is greater than 1000.

• The $next query parameter corresponds to a non-existent page of results.

GET /documents/{documentId}/xbrlProfiles

Required OAuth Scopes

file:read

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-08-01.xbrl.preview)
documentId	path	string	true	The unique identifier of the document
$filter	query	string	false	The properties to filter the results by.
$maxpagesize	query	integer	false	The maximum number of results to retrieve
$next	query	string	false	Pagination cursor for next set of results.

Filter Options

Name	Predicates Supported
archived	eq

Code Samples

curl

curl -X GET https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-08-01.xbrl.preview'

httpie

http GET https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles \
    X-Version:2026-08-01.xbrl.preview \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-08-01.xbrl.preview'

python

import requests

headers = {
  'X-Version': '2026-08-01.xbrl.preview',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/documents/{documentId}/xbrlProfiles', headers = headers)

print(r.json())

Returns

200 - OK

A resulting list of XbrlProfile resources.

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.

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.

Example Responses

200 Response

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "archived": false,
      "id": "9fb1c529-5ccb-48e1-8b19-de1431c3693e",
      "label": "Example Profile"
    }
  ]
}

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"
}

Too Many Requests

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