Retrieve a single audit

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 single audit

GET /prototype/platform/audits/{auditId}

Required OAuth Scopes

graph:read

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
auditId	path	string	true	The unique identifier of the audit
$expand	query	string	false	Returns related resources inline with the main resource

Expand Options

Expands Options Supported
attachments, procedures, procedures.matrices, procedures.attachments

Code Samples

curl

curl -X GET https://api.app.wdesk.com/prototype/platform/audits/{auditId} \
    -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/audits/{auditId} \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/prototype/platform/audits/{auditId}" \
    --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/audits/{auditId}', headers = headers)

print(r.json())

Returns

200 - OK

undefined

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

{
  "archived": true,
  "attachments": [
    {
      "fileName": "signature.jpg"
    }
  ],
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "name": "Process Improvement",
  "procedures": [
    {
      "attachments": [
        {
          "fileName": "signature.jpg"
        }
      ],
      "groupName": "“Group A Responsibilities”",
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_13",
      "matrices": [
        {
          "dataColumns": [
            {
              "externalId": "TA05",
              "id": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
              "name": "PO Number"
            },
            {
              "externalId": "TA06",
              "id": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
              "name": "Amount"
            }
          ],
          "name": "Purchase Orders",
          "resultColumns": [
            {
              "externalId": "TA07",
              "id": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
              "name": "A"
            }
          ]
        }
      ],
      "name": "Procedure 1.1",
      "order": 2,
      "phaseName": "“Planning”"
    }
  ]
}

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