Skip to content

Response model reference

Response records use System.Text.Json attributes for the API wire names. Most model types inherit OkatanaModel, which stores unknown JSON fields in Extra. This supports compatible response growth without discarding new data.

Project

JSON field Schema
id string
organization_id string
name string
key string
description string
archived_at string

Board

JSON field Schema
id string
project_id string
name string
slug string
position integer
color string
wip_limit integer
is_done boolean
is_hidden boolean

Ticket

JSON field Schema
id string
project_id string
board_id string
number integer
title string
description_html string
priority string enum: lowest, low, normal, high, highest, critical
position integer
due_at string
started_at string
completed_at string
api_credential_id string
archived_at string

Document

JSON field Schema
id string
organization_id string
project_id string
author_id string
title string
caption string
content_html string
status string enum: draft, published
api_credential_id string
published_at string
archived_at string
tags array
created_at string (date-time)
updated_at string (date-time)

Flexible models

The OpenAPI file does not define component schemas for every response body. The SDK therefore provides flexible typed records for Organization, ProjectMember, ProjectLabel, ProjectTag, ticket/document comments, project analytics, and notification batch results. Known fields are typed; additional JSON fields remain available in Extra.