Projects

Get a project

Gets a project's name, key and repositories. With fields=settings the response also carries the advanced settings the project stores in its own right, in the shape POST /projects/{projectId} accepts. Settings inherited from the organization, configuration generated by the configuration sync, and secret values (webhook auth headers, AI provider keys and credentials) are not returned.

get/projects/{projectId}

Request

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

Query parameters

fields'settings'

Additional fields to include in the response.

Response

idstring

namestring

keystring

Human-readable project key used in item keys (e.g. KX-PROJ-1)

settingsobject

Present only with fields=settings. Advanced setting names as keys and a JSON value for each setting.

Example response

{
  "settings": {
    "statusMapping": {
      "Backlog": "OPEN",
      "Done": "RESOLVED"
    }
  }
}

Changes

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