{
  "opencollection": "1.0.0",
  "info": {
    "name": "Rhythms (params in:body) access_requests time_periods API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "time_periods",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all time periods",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.rhythms.ai/okrs/time_periods",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination (default: 1)"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of records per page (default: 20, max: 100)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Alias for per_page - number of records per page"
              },
              {
                "name": "limit_max",
                "value": "",
                "type": "query",
                "description": "Maximum number of records per page (overrides limit if not set)"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Ransack query parameters for filtering. In query strings, use bracket notation: q[name_cont]=john&q[status_eq]=active&q[s]=name+asc. Keys are attribute names with predicates: _cont (contains), _eq (equals), _in (array membership), _gteq (>=), _lteq (<=), _present (not null), _null (is null). The \"s\" key sorts results (e.g., q[s]=created_at+desc). Example query string: ?q[name_cont]=john&q[s]=name+asc filters names containing \"john\" sorted by name ascending."
              }
            ]
          },
          "docs": "Retrieves all time periods for the current tenant.\n\nTime periods are automatically ordered with active periods appearing first,\nfollowed by other periods in chronological order. Active time periods are\ndetermined by the current tenant's OKR cycle settings.\n\n\nThis endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, name."
        },
        {
          "info": {
            "name": "Update a time period",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.rhythms.ai/okrs/time_periods/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Time period UUID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing time period with the specified attributes.\n\nTime periods help you organize your OKRs into different blocks of time.\nOptionally, you can update the parent-child relationship between time periods\nto form a hierarchy.\n"
        },
        {
          "info": {
            "name": "Delete a time period",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.rhythms.ai/okrs/time_periods/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Time period UUID"
              }
            ]
          },
          "docs": "Deletes a time period.\n\nA time period cannot be deleted if it is the last remaining time period,\nor if it has associated objectives, key results, or initiatives.\n"
        }
      ]
    }
  ],
  "bundled": true
}