Get an assurance project by id

Table Of Contents

Get an assurance project by id#

Description#

Return a single assurance project of any type.

GET /assuranceProjects/{id}

Required OAuth Scopes

grc:read

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-09-01.grc.preview)
id	path	string	true	The unique system identifier of the resource.
Wk-Workspace	header	string	true	The id of the Workiva workspace to operate in. Authorization is enforced against the authenticated user’s access within this workspace.

Code Samples#

curl

curl -X GET https://api.app.wdesk.com/assuranceProjects/{id} \
    -H 'Accept: application/json' \
    -H 'Wk-Workspace: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-09-01.grc.preview'

httpie

http GET https://api.app.wdesk.com/assuranceProjects/{id} \
    X-Version:2026-09-01.grc.preview \
    Accept:application/json \
    Wk-Workspace:1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/assuranceProjects/{id}" \
    --output-document - \
    --header 'Accept: application/json' \
    --header 'Wk-Workspace: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d' \
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-09-01.grc.preview'

python

import requests

headers = {
  'X-Version': '2026-09-01.grc.preview',
  'Accept': 'application/json',
  'Wk-Workspace': '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/assuranceProjects/{id}', headers = headers)

print(r.json())

Returns#

200 - The requested assurance project.#

An assurance project. Only fields common to every project type are returned, so the shape is stable as new project types are added.

400 - The request was invalid.#

Error response indicating the service could not process the request.

401 - Authentication is missing or invalid.#

Error response indicating the service could not process the request.

403 - The caller is not permitted to access this resource.#

Error response indicating the service could not process the request.

404 - The requested resource was not found.#

Error response indicating the service could not process the request.

429 - The rate limit has been exceeded.#

Error response indicating the service could not process the request.

500 - An unexpected error occurred.#

Error response indicating the service could not process the request.

Example Responses#

The requested assurance project.

{
  "budgetedHours": 1200,
  "contributors": [],
  "endDate": "2026-12-31",
  "id": "019f14d1-7c8a-7f81-bd63-0677ee3fa6f8",
  "managers": [
    {
      "id": "u_4cc9f9128a684f45a7a37b08b70b54c1"
    }
  ],
  "name": "FY26 Controls Testing",
  "objective": "Test the operating effectiveness of key financial controls.",
  "scopingFiles": [
    {
      "id": "019f2b7c-8d9e-7a01-b2c3-4d5e6f7a8b9c",
      "workivaFile": {
        "id": "019f2a3b-4c5d-7e6f-8a9b-0c1d2e3f4a5b",
        "name": "FY26 Materiality Analysis",
        "type": "document"
      }
    }
  ],
  "scopingRationale": "FY26 scope limited to key controls over financial reporting per materiality analysis.",
  "startDate": "2026-01-01",
  "status": "notStarted",
  "type": "independentControlsTesting",
  "year": 2026
}

The request was invalid.

{
  "code": "invalidFilter",
  "message": "The $filter value could not be parsed.",
  "target": "$filter"
}

Authentication is missing or invalid.

{
  "code": "unauthenticated",
  "message": "Authentication credentials were missing or invalid."
}

The caller is not permitted to access this resource.

{
  "code": "permissionDenied",
  "message": "You do not have permission to access this resource."
}

The requested resource was not found.

{
  "code": "notFound",
  "message": "No resource with this id was found."
}

The rate limit has been exceeded.

{
  "code": "rateLimitExceeded",
  "message": "Rate limit exceeded. Retry after the period indicated in the response headers."
}

An unexpected error occurred.

{
  "code": "internalError",
  "message": "An unexpected error occurred. Please try again later."
}