Read EDMS documents in a project (subject to change)

Documents are items, so a document ID is an item ID. There is no document-specific history endpoint: read a document's revisions from GET /projects/{projectId}/items/{itemId}/records, passing the document ID as the item ID.

get/projects/{projectId}/items/documents

Request

Base URL
https://app.ketryx.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ketryx/apis/ketryx-api/docs/projects/:projectId/items/documents/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

Ketryx ID of the project, e.g., KXPRJ12345

Query parameters

startAtinteger

Index to start at. Defaults to 0.

maxResultsinteger

Maximum number of results to return

folderPathstring

Path of the containing EDMS folder, with / separating folder names. Empty for the project root.

Response

Successful response

startAtinteger required

Index that the pagination started at

maxResultsinteger required

Maximum number of results returned

Changes

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