latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Sections

Create Section

Create a new section

post/api/v1/sections

Request body

namestring required

Name of the new section.

project_idstring required

ID of the project to add the section to

orderinteger nullable

Position of the new section in the project

descriptionstring nullable

Description of the new section.

Example request

{
  "name": "Groceries",
  "project_id": "6XGgm6PHrGgMpCFX",
  "order": 12,
  "description": "Tasks for the launch plan"
}

Response

Successful Response

idstring required

String ID of the section.

user_idstring required

String ID of the user who owns the section.

project_idstring required

String ID of the project that contains the section.

added_atstring date-time required

Date and time when the section was created.

updated_atstring date-time nullable required

Date and time when the section was last updated, or null if unknown.

archived_atstring date-time nullable required

Date and time when the section was archived, or null if it is active.

namestring required

Section name.

descriptionstring nullable required

Section description, or null if it has none.

section_orderinteger required

Position of the section in the project.

order_keystring nullable required

Fractional-indexing order key: sections sort by comparing keys lexicographically within a project. May be null for projects not yet migrated.

is_collapsedboolean required

Whether the section is collapsed in the user's view.

is_archivedboolean required

Whether the section is archived.

is_deletedboolean required

Whether the section is deleted.

Example response

{
  "id": "6fFPHV272WWh3gpW",
  "user_id": "1234567",
  "project_id": "6XGgm6PHrGgMpCFX",
  "added_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-16T10:30:00Z",
  "archived_at": "2025-01-17T10:30:00Z",
  "name": "Groceries",
  "description": "Tasks for the launch plan",
  "section_order": 1,
  "order_key": "a1V"
}