{
  "opencollection": "1.0.0",
  "info": {
    "name": "Oneflow Public Comments Contracts API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-oneflow-api-token",
      "value": "{{x-oneflow-api-token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Contracts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.oneflow.com/v1/contracts",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Pagination offset."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return."
              }
            ]
          },
          "docs": "Retrieves the list of contracts available to the acting user."
        },
        {
          "info": {
            "name": "Create a contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.oneflow.com/v1/contracts/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new contract in a workspace from a template. Requires a `workspace_id` and `template_id`, and typically the parties, data fields, and products to populate."
        },
        {
          "info": {
            "name": "Get a contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.oneflow.com/v1/contracts/:contract_id",
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contract."
              }
            ]
          },
          "docs": "Retrieves a single contract by its ID."
        },
        {
          "info": {
            "name": "Update a contract",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.oneflow.com/v1/contracts/:contract_id",
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contract."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the top-level information of a draft contract (modeled)."
        },
        {
          "info": {
            "name": "Delete a contract",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.oneflow.com/v1/contracts/:contract_id",
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contract."
              }
            ]
          },
          "docs": "Deletes a contract (modeled)."
        },
        {
          "info": {
            "name": "Publish a contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.oneflow.com/v1/contracts/:contract_id/publish",
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contract."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Publishes a draft contract, sending the invitation/signing message to its participants."
        },
        {
          "info": {
            "name": "Copy a contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.oneflow.com/v1/contracts/:contract_id/copy",
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path",
                "description": "The ID of the contract."
              }
            ]
          },
          "docs": "Creates a copy of an existing contract (modeled)."
        }
      ]
    }
  ],
  "bundled": true
}