Ketryx Documentation
Book a DemoFAQTraining Videos
  • Introduction
  • 📄Manuals
    • MAN-01 Ketryx Lifecycle Management
    • MAN-02 Software Release Process
    • MAN-03 Supply Chain Management: Software Dependencies
      • Threat Modeling
      • Vulnerability Management
      • Working with CycloneDX
      • Working with SPDX
    • MAN-04 Supply Chain Management: Cloud Dependencies
    • MAN-05 Milestones
    • MAN-06 Test Management
    • MAN-07 Traceability
    • MAN-08 Risk Management
    • MAN-09 Git-Based Configuration Items
    • MAN-10 Managing items in Ketryx
    • MAN-11 Approval Rules
    • MAN-12 Computational Controls
    • MAN-13 Data Export
  • 🛠️Work Instructions
    • WI-01 Requirement
    • WI-02 Software Item Specification
    • WI-03 Task
    • WI-04 Test Case
    • WI-05 Test Execution
    • WI-06 Anomaly
    • WI-07 Complaint
    • WI-08 Change Request
    • WI-09 Corrective and Preventive Action (CAPA)
    • WI-10 Risk
    • WI-11 Document
  • 🌐Integrations
    • Jira
    • Azure DevOps
    • TestRail
    • Jama
    • Polarion
    • Chrome extension
    • Source Code
      • Azure DevOps
      • Bitbucket
      • GitHub
      • GitLab
      • Code Change Reviews
    • Release documents
      • Google Workspace
    • Authentication
  • 📚Reference
    • Ketryx Query Language
    • Advanced Settings
    • Glob Pattern Matching Algorithm
    • Traceability Configuration
    • Document Templating
    • Project Settings
    • Custom Item Types
    • Assistant
    • Agents
    • Release Notes
  • 🔃API
    • Authentication
    • Build API
    • Project API
    • Item API
    • Webhooks
Powered by GitBook

Ketryx

  • ketryx.com
  • What is Ketryx?

Resources

  • FAQ
  • Training Videos

© 2025 Ketryx Corporation

On this page

Was this helpful?

Export as PDF
  1. API

Item API

API to manage configuration items and records in Ketryx

PreviousProject APINextWebhooks

Last updated 6 months ago

Was this helpful?

Ketryx exposes an API to manage configuration items programmatically. See also the documentation on and .

These API endpoints generally use pagination, based on the query parameters startAt and maxResults. The maximum number of entries to return at once is 1000. The effective values of startAt and maxResults is also returned as part of the API response.

Items

Item records

Query project records

Use this API to query records based on a query.

🔃
KQL
authentication and API keys
webhooks

Read all items in a project

get
Path parameters
projectIdstringRequired

Ketryx ID of the project to query items for

Query parameters
startAtintegerOptional

Index to start at. Defaults to 0.

Default: 0
maxResultsinteger · min: 1 · max: 1000Optional

Maximum number of results to return

Default: 1000
Responses
200
Successful response
application/json
default
Error response
application/json
get
GET /api/v1/projects/{projectId}/items HTTP/1.1
Host: app.ketryx.com
Accept: */*
{
  "items": [
    {
      "id": "text",
      "externalIds": [
        {
          "system": "Jira",
          "id": "text",
          "key": "text",
          "projectId": "text"
        }
      ],
      "createdAt": "2025-05-09T10:35:01.417Z",
      "isExcluded": true,
      "folderPath": [
        "text"
      ],
      "currentRecord": {
        "id": "text"
      },
      "controlledRecord": {
        "id": "text"
      }
    }
  ],
  "startAt": 1,
  "maxResults": 1
}

Read all item records for an item

get
Path parameters
projectIdstringRequired

Ketryx ID of the project

itemIdstringRequired

Ketryx ID of the item

Query parameters
startAtintegerOptional

Index to start at. Defaults to 0.

Default: 0
maxResultsinteger · min: 1 · max: 1000Optional

Maximum number of results to return

Default: 1000
Responses
200
Successful response
application/json
default
Error response
application/json
get
GET /api/v1/projects/{projectId}/items/{itemId}/records HTTP/1.1
Host: app.ketryx.com
Accept: */*
{
  "records": [
    {
      "id": "text",
      "itemId": "text",
      "type": "text",
      "title": "text",
      "isControlled": true,
      "revision": 1,
      "createdAt": "2025-05-09T10:35:01.417Z",
      "introducedInVersion": {
        "id": "text",
        "name": "text"
      },
      "obsoleteInVersion": {
        "id": "text",
        "name": "text"
      },
      "fields": [
        {
          "label": "text",
          "type": "string",
          "value": null
        }
      ],
      "relations": [
        {
          "type": "text",
          "toItem": {
            "id": "text",
            "projectId": "text"
          }
        }
      ],
      "fileUrl": "text"
    }
  ],
  "startAt": 1,
  "maxResults": 1
}

Query item records in a project

get
Path parameters
projectIdstringRequired

Ketryx ID of the project

Query parameters
versionIdstringOptional
comparedVersionIdstringOptional
querystringRequired

KQL query string

startAtintegerOptional

Index to start at. Defaults to 0.

Default: 0
maxResultsinteger · min: 1 · max: 1000Optional

Maximum number of results to return

Default: 1000
Responses
200
Successful response
application/json
default
Error response
application/json
get
GET /api/v1/projects/{projectId}/records HTTP/1.1
Host: app.ketryx.com
Accept: */*
{
  "records": [
    {
      "id": "text",
      "itemId": "text",
      "type": "text",
      "title": "text",
      "isControlled": true,
      "revision": 1,
      "createdAt": "2025-05-09T10:35:01.417Z",
      "introducedInVersion": {
        "id": "text",
        "name": "text"
      },
      "obsoleteInVersion": {
        "id": "text",
        "name": "text"
      },
      "fields": [
        {
          "label": "text",
          "type": "string",
          "value": null
        }
      ],
      "relations": [
        {
          "type": "text",
          "toItem": {
            "id": "text",
            "projectId": "text"
          }
        }
      ],
      "fileUrl": "text"
    }
  ],
  "startAt": 1,
  "maxResults": 1,
  "total": 1
}
  • Items
  • GETRead all items in a project
  • Item records
  • GETRead all item records for an item
  • Query project records
  • GETQuery item records in a project