Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Create iteration

POST

https://example.kaiten.ru/api/latest/spaces/{space_uid}/iterations

This endpoint is currently under active development. Parameters, attributes, and response formats are subject to change. Iterations API is in beta and may change.

Creates a new iteration in a space. A created iteration gets the planned status. The iterations feature must be enabled for the company.

Path parameters

Name	Type	Reference
space_uidrequired	string	Space UID

Headers

Name	Value
Authorization	Bearer <token>
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "title": {
   "type": "string",
   "minLength": 1,
   "maxLength": 256,
   "description": "Iteration title"
  },
  "goal": {
   "type": [
    "string",
    "null"
   ],
   "description": "Iteration goal"
  },
  "start_date": {
   "type": [
    "string",
    "null"
   ],
   "format": "date-time",
   "description": "Start date. ISO 8601 format"
  },
  "finish_date": {
   "type": [
    "string",
    "null"
   ],
   "format": "date-time",
   "description": "Finish date. ISO 8601 format"
  }
 },
 "required": [
  "title"
 ]
}

Name	Type	Constraints	Description
title required	string	minLength: 1 maxLength: 256	Iteration title
goal	string \| null		Iteration goal
start_date	string \| null		Start date. ISO 8601 format
finish_date	string \| null		Finish date. ISO 8601 format

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Iteration ID (UUID)
space_uid	string	UID of the space the iteration belongs to
title	string	Iteration title
goal	string	Iteration goal
status	string	Iteration status: planned, active, closed or removed
creator_uid	string	UID of the user who created the iteration
updater_uid	string	UID of the user who last updated the iteration
start_date	string	Start date, ISO 8601 format
finish_date	string	Planned finish date, ISO 8601 format
actual_finish_date	string	Actual finish date, ISO 8601 format
sort_order	number	Sort order of the iteration within the space
data	object	Iteration statistics, present for active and closed iterations
created	string	Creation timestamp
updated	string	Last update timestamp

400

Description	Response type	Example
Validation error	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

403

Description	Response type	Example
Forbidden		Response body does not exist

A schema has not been defined for this response code.

404

Description	Response type	Example
Space not found		Response body does not exist

A schema has not been defined for this response code.

Kaiten

Addons terms of use Personal data processing policy

If you have any questions or need help with integration feel free to write us at support@kaiten.ru

Company domain

Path Parameters

space_uid

Raw Body(json format)

  1  curl --request POST \
  2       --url 'https://example.kaiten.ru/api/latest/spaces/{space_uid}/iterations' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!