Task Formats

Read task format reference data.

List task formats

GET

https://api.kordiam.app

/api/v2/task-formats

Bearer (JWT)

List task formats › query Parameters

page

integer · int32 · min: 0

0-based page number for offset pagination. Mutually exclusive with cursor.

cursor

string · maxLength: 2048 · pattern: ^[A-Za-z0-9._~\-]*$

Opaque cursor for keyset pagination. Mutually exclusive with page. Clients must not parse or construct it; pass the nextCursor value back unchanged. Current tokens use the shared v1.BASE64... format.

size

integer · int32 · min: 1 · max: 100

Requested page size. Defaults to 20 and must not exceed 100.

active

boolean

Filter by active state.

List task formats › Responses

TaskFormatListResponse

TaskFormatApiModel[]

Items returned in this response.

hasMore

boolean

Whether more results are available.

nextCursor

string

Cursor for the next page of results.

PageMetadata

Page-based pagination metadata.

size

integer · int32

Requested page size.

GET/api/v2/task-formats

curl https://api.kordiam.app/api/v2/task-formats \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "content": [
    {
      "active": true,
      "defaultTaskStatus": {
        "active": true,
        "id": 31,
        "name": "In Progress"
      },
      "id": 18,
      "name": "Text",
      "taskStatuses": [
        {
          "active": true,
          "id": 31,
          "name": "In Progress"
        },
        {
          "active": false,
          "id": 32,
          "name": "Done"
        }
      ],
      "textLength": {
        "countingTypeCode": 1,
        "emptyValueAllowed": true,
        "options": [
          {
            "id": 1,
            "label": "Short",
            "maxValue": 140
          },
          {
            "id": 2,
            "label": "Long",
            "maxValue": 4000
          }
        ]
      },
      "typeCode": 1
    }
  ],
  "hasMore": false,
  "page": {
    "number": 0,
    "totalElements": 1,
    "totalPages": 1
  },
  "size": 1
}

json

application/json

Get task format by ID

GET

https://api.kordiam.app

/api/v2/task-formats/{id}

Bearer (JWT)

Get task format by ID › path Parameters

id

integer · int64 · min: 1 · required

Get task format by ID › Responses

TaskFormatApiModel

active

boolean

Whether the format is active.

StatusApiModel

Default task status for the format.

id

integer · int64

Format ID.

name

string

Format name.

StatusApiModel[]

Available task statuses for the format.

TaskFormatTextLengthSettings

Text length metadata. Available only for text formats.

typeCode

integer · enum · int32

Task format type code.

Enum values:

Default: null

GET/api/v2/task-formats/{id}

curl https://api.kordiam.app/api/v2/task-formats/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "active": true,
  "defaultTaskStatus": {
    "active": true,
    "id": 31,
    "name": "In Progress"
  },
  "id": 18,
  "name": "Text",
  "taskStatuses": [
    {
      "active": true,
      "id": 31,
      "name": "In Progress"
    },
    {
      "active": false,
      "id": 32,
      "name": "Done"
    }
  ],
  "textLength": {
    "countingTypeCode": 1,
    "emptyValueAllowed": true,
    "options": [
      {
        "id": 1,
        "label": "Short",
        "maxValue": 140
      },
      {
        "id": 2,
        "label": "Long",
        "maxValue": 4000
      }
    ]
  },
  "typeCode": 1
}

json

application/json

Platforms Task Statuses

List task formats

GET

https://api.kordiam.app

/api/v2/task-formats

Bearer (JWT)

List task formats › query Parameters

page

integer · int32 · min: 0

0-based page number for offset pagination. Mutually exclusive with cursor.

cursor

string · maxLength: 2048 · pattern: ^[A-Za-z0-9._~\-]*$

size

integer · int32 · min: 1 · max: 100

Requested page size. Defaults to 20 and must not exceed 100.

active

boolean

Filter by active state.

List task formats › Responses

TaskFormatListResponse

TaskFormatApiModel[]

Items returned in this response.

hasMore

boolean

Whether more results are available.

nextCursor

string

Cursor for the next page of results.

PageMetadata

Page-based pagination metadata.

size

integer · int32

Requested page size.

Get task format by ID

GET

https://api.kordiam.app

/api/v2/task-formats/{id}

Bearer (JWT)

Get task format by ID › path Parameters

id

integer · int64 · min: 1 · required

Get task format by ID › Responses

TaskFormatApiModel

active

boolean

Whether the format is active.

StatusApiModel

Default task status for the format.

id

integer · int64

Format ID.

name

string

Format name.

StatusApiModel[]

Available task statuses for the format.

TaskFormatTextLengthSettings

Text length metadata. Available only for text formats.

typeCode

integer · enum · int32

Task format type code.

Enum values:

Default: null