Skip to main content

Folders

List folders

List folders with GET​

GET/api/public/v0/project/{project_code}/tcase/folders

Get a list of all folders in the project. Useful to get ids of folders.

Request Parameters​

  • Page: The current page number of the results. (page)
  • Limit: The maximum number of items returned per page. (limit)
  • SortField: The field (allowed values: id, project_id, title, pos, parent_id, created_at, updated_at) by which the results are sorted. (sortField)
  • SortOrder: The order of sorting (asc or desc). SortField must be specified. (sortOrder)
GET/tcase/folders?limit=10&priorities=high&priorities=medium

Response​

Status: 200

{
  "type": "object",
  "required": ["total", "page", "limit", "data"],
  "properties": {
    "total": {
      "type": "integer",
      "description": "The total number of items available."
    },
    "page": {
      "type": "integer",
      "description": "The current page number of the results."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of items returned per page."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["id", "parentId", "title", "comment", "projectId", "pos"],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique identifier for the item."
          },
          "parentId": {
            "type": "integer",
            "description": "The identifier of the parent item. A value of 0 indicates no parent."
          },
          "title": {
            "type": "string",
            "description": "The title of the item."
          },
          "comment": {
            "type": "string",
            "description": "Additional remarks or notes about the item."
          },
          "projectId": {
            "type": "string",
            "description": "The identifier of the project to which the item belongs."
          },
          "pos": {
            "type": "integer",
            "description": "The position of the item within its parent."
          }
        }
      }
    }
  }
}

Example Response​

{
    "total": 4,
    "page": 0,
    "limit": 0,
    "data": [
        {
            "id": 1,
            "parentId": 0,
            "title": "Bistro Delivery",
            "comment": "This is the main folder",
            "projectId": "1CDaS6SEs_vJZ9SDqb8P5DZ",
            "pos": 1
        },
        {
            "id": 2,
            "parentId": 1,
            "title": "Welcome",
            "comment": "",
            "projectId": "1CDaS6SEs_vJZ9SDqb8P5DZ",
            "pos": 4
        },
        {
            "id": 3,
            "parentId": 1,
            "title": "Cart",
            "comment": "",
            "projectId": "1CDaS6SEs_vJZ9SDqb8P5DZ",
            "pos": 1
        },
        {
            "id": 4,
            "parentId": 1,
            "title": "Today's menu",
            "comment": "",
            "projectId": "1CDaS6SEs_vJZ9SDqb8P5DZ",
            "pos": 3
        }
    ]
}