Audits

Retrieve an audit

Retrieves an audit belonging to the authenticated client.

Client API keys are tenant-scoped. A client cannot retrieve another client's audit. A temporary signed PDF URL is generated when a PDF exists, with a 3600-second expiry.

get/audits/{audit_id}

Request

Base URL
http://127.0.0.1:5000/api/v1
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/clinicalauditai/apis/clinicalauditai-api/docs/audits/:audit_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

audit_idstring uuid required

UUID of the audit

Response

Audit retrieved successfully

audit_idstring uuid required

statusstring required

created_atstring date-time required

completed_atstring date-time required

resultstring required

pdf_statusstring required

pdf_urlstring uri nullable required

pdf_url_expires_ininteger nullable required

email_status'pending' | 'sent' | 'failed' | 'not_requested' required

webhook_status'pending' | 'sent' | 'failed' | 'not_requested' required

Example response

{
  "pdf_url_expires_in": 3600
}

Changes

No recorded changes to this operation across all 1 revision of this API.