Get document
GET /api/v3/documents/{id}
Request conventions
API key or OAuth2 access token. See Authentication.
Use your account domain and token in copied requests. Request values and conditional fields must satisfy your account’s validation rules.
URL settings
The part before .aha.io. Leave blank to use the example domain.
ID or reference number of the document
Response fields
Choose which fields to include in the response. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.
Default response fields are returned until you select specific fields.
| Field | Type | Returned by default |
|---|---|---|
Unique record ID. | integer | Yes |
URL to view the record in Aha! | string | Yes |
API URL for the record. | string | Yes |
Name of the record. | string | Yes |
Reference number of the record. | string | Yes |
Type of the document. | string | No |
Allowed values: | ||
Date of the document. For meeting and meeting whiteboard documents, the date and time of the meeting. | date-time | No |
Length of the meeting in minutes. Only set for meeting and meeting whiteboard documents. | integer | No |
Location of the meeting, such as a room or a video call URL. Only set for meeting and meeting whiteboard documents. | string | No |
URL the document links to. Only set for external link documents. | string | No |
Position of the record relative to its siblings. | integer | No |
Date and time when the record was created. | date-time | No |
Date and time when the record was last updated. | date-time | No |
Status assigned to the document. Only available when the user has Knowledge Advanced. Availability depends on account settings. | Status | No |
Expand this association to browse its response fields. | ||
Workspace that contains the record. | Project | No |
Expand this association to browse its response fields. | ||
User who created the record. | User | No |
Expand this association to browse its response fields. | ||
Folder or document that contains the document. | Document | No |
Expand this association to browse its response fields. | ||
HTML body of the document. | Note | No |
Expand this association to browse its response fields. | ||
File attached to the document. Only set for file documents. | DocumentFile | No |
Expand this association to browse its response fields. | ||
Record the document links to. Only set for internal link documents. | LinkedRecord | No |
Expand this association to browse its response fields. | ||
Users attending the meeting. Empty for documents other than meetings and meeting whiteboards. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=attendees[default]). Capped at 25 records. Only available on the top-level resource. | Collection | No |
Collection envelopeRecords use the associated fields below. Type: Required properties: records, has_more. Expand this association to browse its response fields. | ||
Internal comments on the record. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=comments[default]). Capped at 25 records. Only available on the top-level resource. | Collection | No |
Collection envelopeRecords use the associated fields below. Type: Required properties: records, has_more. Expand this association to browse its response fields. | ||
Status intervals for the document. Requires Knowledge Advanced. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=workflow_status_times[default]). Capped at 25 records. Only available on the top-level resource. Availability depends on account settings. | Collection | No |
Collection envelopeRecords use the associated fields below. Type: Required properties: records, has_more. Expand this association to browse its response fields. | ||
Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.
Response field selection
Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.
See field selection for details.
Response statuses
Error shape for 401, 403, 404
Type: object
error
Type: object
Required properties: status, code, message, request_id.
status
Type: integer
code
Type: string
message
Type: string
request_id
Type: string
Response envelope and pagination
record: a single record. Fields are documented above.