Retrieve a style guide by id#
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 the StyleGuide populated with the text styles, list styles, etc. The revision will ensure a static content.
GET /prototype/platform/content/styleGuides/{styleGuideId}
Required OAuth Scopes
file:read
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
false |
Version of the API (2022-01-01) |
styleGuideId |
path |
string |
true |
The unique identifier of the style guide |
$revision |
query |
string |
false |
Returns resources at a specific revision |
Code Samples#
curl -X GET https://api.app.wdesk.com/prototype/platform/content/styleGuides/{styleGuideId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2022-01-01'
http GET https://api.app.wdesk.com/prototype/platform/content/styleGuides/{styleGuideId} \
X-Version:2022-01-01 \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/prototype/platform/content/styleGuides/{styleGuideId}" \
--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/content/styleGuides/{styleGuideId}', headers = headers)
print(r.json())
Returns#
200 - OK#
Returns a StyleGuide object containing details about the requested StyleGuide.
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#
{
"id": "e810327bd46b4438b7feed9f1e2d055d",
"orderedListStyles": [
{
"id": "bGlzdC5hcmFiaWM6ZTgxMDMyN2JkNDZiNDQzOGI3ZmVlZDlmMWUyZDA1NWQ",
"index": 0,
"isNormalStyle": true,
"listProgressions": [
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "numericSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 1
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "lowercaseAlphabeticSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 2
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignRight"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "lowercaseRomanSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 3
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "numericSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 4
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "lowercaseAlphabeticSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 5
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignRight"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "lowercaseRomanSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 6
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "numericSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 7
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "lowercaseAlphabeticSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 8
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignRight"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "lowercaseRomanSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 9
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": "."
},
"style": {
"sequenceType": "numericSequence"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 10
}
],
"name": "Numbered",
"notes": "",
"type": "orderedListStyle"
}
],
"revision": "2c6438ab455b1513",
"tableStyles": [
{
"formats": {
"alignment": null,
"characterSpacing": {
"characterSpacing": 0,
"locked": false
},
"emphasis": {
"bold": false,
"italic": false,
"locked": false,
"underline": false
},
"firstLineIndent": {
"firstLineIndent": 0,
"locked": false
},
"fontColor": {
"fontColor": {
"blue": 0,
"green": 0,
"red": 0
},
"locked": false
},
"fontFamily": {
"fontFamily": "Arial",
"locked": true
},
"fontSize": {
"fontSize": 10,
"locked": true
},
"lineSpacing": {
"lineSpacing": 100,
"locked": false,
"unit": "percent"
},
"spaceAfterParagraph": {
"locked": false,
"spaceAfterParagraph": 0
},
"spaceBeforeParagraph": {
"locked": false,
"spaceBeforeParagraph": 0
},
"startIndent": {
"locked": false,
"startIndent": 0
}
},
"id": "X3RibDplODEwMzI3YmQ0NmI0NDM4YjdmZWVkOWYxZTJkMDU1ZA",
"index": 0,
"isNormalStyle": true,
"name": "Table (Normal)",
"notes": ""
}
],
"textStyles": [
{
"formats": {
"alignment": null,
"characterSpacing": {
"characterSpacing": 0,
"locked": false
},
"emphasis": {
"bold": false,
"italic": false,
"locked": false,
"underline": false
},
"firstLineIndent": {
"firstLineIndent": 0,
"locked": false
},
"fontColor": {
"fontColor": {
"blue": 0,
"green": 0,
"red": 0
},
"locked": false
},
"fontFamily": {
"fontFamily": "Arial",
"locked": true
},
"fontSize": {
"fontSize": 12,
"locked": true
},
"lineSpacing": {
"lineSpacing": 120,
"locked": false,
"unit": "percent"
},
"spaceAfterParagraph": {
"locked": false,
"spaceAfterParagraph": 0
},
"spaceBeforeParagraph": {
"locked": false,
"spaceBeforeParagraph": 0
},
"startIndent": {
"locked": false,
"startIndent": 0
}
},
"id": "X3R4dDplODEwMzI3YmQ0NmI0NDM4YjdmZWVkOWYxZTJkMDU1ZA",
"index": 0,
"isNormalStyle": true,
"name": "Normal",
"notes": "",
"type": "paragraphStyle"
}
],
"unorderedListStyles": [
{
"id": "YnVsbGV0LnJvdW5kOmU4MTAzMjdiZDQ2YjQ0MzhiN2ZlZWQ5ZjFlMmQwNTVk",
"index": 0,
"isNormalStyle": true,
"listProgressions": [
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "•"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 1
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "◦"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 2
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "▪"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 3
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "•"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 4
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "◦"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 5
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "▪"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 6
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "•"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 7
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "◦"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 8
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "▪"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 9
},
{
"formats": {
"bold": null,
"fontFamily": null,
"glyphAlignment": {
"alignment": "glyphAlignLeft"
},
"indentation": null,
"italic": null,
"listText": {
"locked": false,
"prefix": "",
"suffix": ""
},
"style": {
"sequenceType": "unorderedSequence",
"unorderedGlyph": "•"
},
"symbolColor": null,
"symbolSize": null,
"underline": null
},
"listLevel": 10
}
],
"name": "Bullet",
"notes": "",
"type": "unorderedListStyle"
}
]
}
{
"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"
}