Items

Query item records in a project

get/projects/{projectId}/records

Request

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

projectIdstring required

Ketryx ID of the project to query items for

startAtinteger

Index to start at. Defaults to 0.

maxResultsinteger

Maximum number of results to return

versionIdstring

Ketryx ID of the version, e.g., KXVSN12345

comparedVersionIdstring

Ketryx ID of the version, e.g., KXVSN12345

fieldsstring[]

Optional comma-separated list of additional fields to include in the response: approvalState, authors, versions

querystring required

KQL query string

Successful response

startAtinteger required

Index that the pagination started at

maxResultsinteger required

Maximum number of results returned

totalnumber required

Total number of items matching the query

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