PRproductive
Folders

Get folders

Changed on

Returns a paginated list of folders — the top-level groupings inside a project that hold its task lists. Supports filtering by project, status, and free-text query.

get/api/v2/folders

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/folders
  • Auth
    none declared

Query parameters

OR

Filter folders by specific criteria. Accepts a filter object with field-value pairs.

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}
sortstring[]

Sort folders by one or more fields. Prefix a field name with a minus sign for descending order.

Response

A paginated collection of folder resources.

Example response

{
  "data": [
    {
      "id": "5522",
      "type": "folders",
      "attributes": {
        "name": "Features",
        "position": 1,
        "placement": 1000000,
        "archived_at": null,
        "hidden": false
      },
      "relationships": {
        "project": {
          "data": {
            "type": "projects",
            "id": "6899"
          }
        }
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      the /// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the /// response property anyOf list for the response status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ////// became required for the status

    This list may be incomplete.