Skip to main content
GET
/
api
/
projects
/
{id}
Get a single project's full detail
curl --request GET \
  --url https://app.auditynow.com/api/projects/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientName": "<string>",
  "industry": "<string>",
  "companySize": "<string>",
  "status": "setup",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "currency": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "documentsCount": 123,
  "analysisProgress": 50,
  "stakeholdersCount": 123,
  "hasAnalysis": true,
  "hasInterviewAnalysis": true,
  "hasAuditAnalysis": true,
  "hasQuestionnaires": true,
  "hasDeliverables": true,
  "statusLabel": "<string>",
  "statusDescription": "<string>",
  "lastActivity": {
    "type": "document_upload",
    "date": "2023-11-07T05:31:56Z",
    "description": "<string>"
  },
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fileName": "<string>",
      "fileType": "<string>",
      "fileSize": 123,
      "storagePath": "<string>",
      "uploadStatus": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "businessAnalysis": [
    {}
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Path Parameters

id
string<uuid>
required

The project's UUID.

Response

Project detail

id
string<uuid>
required
clientName
string
required
industry
string
required
companySize
string
required
status
enum<string>
required

Lifecycle state of an audit project.

Available options:
setup,
analysis,
interviews,
complete,
archived
createdAt
string<date-time>
required
description
string | null
currency
string
updatedAt
string<date-time>
documentsCount
integer
analysisProgress
integer

Percentage 0-100 representing how far through the audit lifecycle this project is.

Required range: 0 <= x <= 100
stakeholdersCount
integer
hasAnalysis
boolean
hasInterviewAnalysis
boolean
hasAuditAnalysis
boolean
hasQuestionnaires
boolean
hasDeliverables
boolean
statusLabel
string
statusDescription
string
lastActivity
object
documents
object[]
businessAnalysis
object[]

Inline business analysis records, if present. Empty array when none.