{
  "opencollection": "1.0.0",
  "info": {
    "name": "LawVu Account Auth Contracts API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Contracts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v2/contracts",
            "params": [
              {
                "name": "$filter",
                "value": "",
                "type": "query",
                "description": "Filter the results using OData filter syntax"
              },
              {
                "name": "$orderby",
                "value": "",
                "type": "query",
                "description": "Order the results using OData orderby syntax"
              },
              {
                "name": "$skip",
                "value": "",
                "type": "query",
                "description": "Skip the specified number of results"
              },
              {
                "name": "$top",
                "value": "",
                "type": "query",
                "description": "Limit the number of results returned"
              }
            ]
          },
          "docs": "Retrieve a list of contracts"
        },
        {
          "info": {
            "name": "Create contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.lawvu.com/account-apis/v2/contracts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a contract based on the provided contract type."
        },
        {
          "info": {
            "name": "Get contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v2/contracts/:contractId",
            "params": [
              {
                "name": "contractId",
                "value": "5348",
                "type": "path",
                "description": "The system identifier for the contract"
              }
            ]
          },
          "docs": "Retrieve a contract by its identifier"
        },
        {
          "info": {
            "name": "Update contract",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.lawvu.com/account-apis/v2/contracts/:contractId",
            "params": [
              {
                "name": "contractId",
                "value": "5348",
                "type": "path",
                "description": "The system identifier for the contract"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a contracts details"
        },
        {
          "info": {
            "name": "Get contract file",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v2/contracts/:contractId/files/:fileId",
            "params": [
              {
                "name": "contractId",
                "value": "5348",
                "type": "path",
                "description": "The system identifier for the contract"
              },
              {
                "name": "fileId",
                "value": "9456",
                "type": "path",
                "description": "The system identifier for the file"
              }
            ]
          },
          "docs": "Retrieve information about a file on a contract"
        },
        {
          "info": {
            "name": "Get contract types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v2/contractTypes",
            "params": [
              {
                "name": "$skip",
                "value": "",
                "type": "query",
                "description": "Specifies the number of items to skip"
              },
              {
                "name": "$top",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a list of contract types"
        },
        {
          "info": {
            "name": "Get contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts",
            "params": [
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "The number of contracts to skip (used for paging)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields to include in the response"
              },
              {
                "name": "filtering.logic",
                "value": "",
                "type": "query",
                "description": "Gets or sets the filtering logic for filters. Value by default is 'and'"
              },
              {
                "name": "filtering.filters",
                "value": "",
                "type": "query",
                "description": "Array of filters object (optional)\r\n<br /> \r\n_Object Properties_:\r\n<br /> \r\n* _Field_: field to filter by\r\n<br /> \r\n* _Operator_: operator used to filter by\r\n<br /> \r\n* _Value_: value to filter by"
              },
              {
                "name": "filtering.field",
                "value": "",
                "type": "query",
                "description": "Field to filter by (optional)"
              },
              {
                "name": "filtering.operator",
                "value": "",
                "type": "query",
                "description": "Operator used for filtering (optional)"
              },
              {
                "name": "filtering.value",
                "value": "",
                "type": "query",
                "description": "Value to filter by (optional)"
              },
              {
                "name": "sorting.direction",
                "value": "",
                "type": "query",
                "description": "Set the sorting direction"
              },
              {
                "name": "sorting.field",
                "value": "",
                "type": "query",
                "description": "Set the sorting fields"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "The maximum number of contracts to return<p>Default: 50</p>"
              },
              {
                "name": "context",
                "value": "",
                "type": "query",
                "description": "Controls the scope of contracts returned by this operation<p>Default: Personal</p><p>Options:</p><ul><li>All - Returns all contracts regardless of whether the authenticated user is a member. Requires the authenticated user to be a member of the Contract Administrators security group</li><li>Personal - Returns contracts which the authenticated user is a member of. Equivalent to the \"My contracts\" view in LawVu</li><li>Teams - Returns all contracts that are accessible by teams that the authenticated user is a member of</li><li>Restricted - Returns restricted contracts. Requires the authenticated user to be an Organization Administrator</li></ul>"
              }
            ]
          },
          "docs": "Gets contracts filtered by single or multiple fields.\r\n<br /> \r\n_To filter by one field_: \"filtering.field\", \"filtering.operator\" and \"filtering.value\" parameters must be filled.\r\n<br /> \r\n_To filter by multiple fields_: \"filtering.logic\" and \"filtering.filters\" parameters must be filled."
        },
        {
          "info": {
            "name": "Create contract by upload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts",
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "ContractTemplateId",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "MatterId",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "ParentContractId",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Fields",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "Name",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "ExternalId",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "TeamId",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "ContractFile",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Creates a new contract, with the main contract file being sent in the body of the request"
        },
        {
          "info": {
            "name": "Find contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/quickfind",
            "params": [
              {
                "name": "term",
                "value": "",
                "type": "query",
                "description": "A term to search contracts by"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "The number of contracts to return (maximum: 100, default: 20)"
              }
            ]
          },
          "docs": "Quickly find and filter contracts"
        },
        {
          "info": {
            "name": "Recent  contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/recent",
            "params": [
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "The number of recently viewed contracts to return<p>Default: 5</p>"
              }
            ]
          },
          "docs": "Returns recently viewed (ref:take) contracts for the user"
        },
        {
          "info": {
            "name": "Contract entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/entities"
          },
          "docs": "Gets contract entities (other parties)"
        },
        {
          "info": {
            "name": "Create contract entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/entities",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a contract entity"
        },
        {
          "info": {
            "name": "ExternalId lookup",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/externalid/:externalId",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "The externalId to lookup"
              }
            ]
          },
          "docs": "ExternalId lookup"
        },
        {
          "info": {
            "name": "Get contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/:contractId",
            "params": [
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "The Id of the contract"
              }
            ]
          },
          "docs": "Get contract details by contract id"
        },
        {
          "info": {
            "name": "Update contract",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/:contractId",
            "params": [
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "The Id of the contract"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update contract"
        },
        {
          "info": {
            "name": "Get contract fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/:contractId/fields",
            "params": [
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "The Id of the contract"
              }
            ]
          },
          "docs": "Get contract fields by contract id"
        },
        {
          "info": {
            "name": "Update fields",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/:contractId/fields",
            "params": [
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "The Id of the contract"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update fields"
        },
        {
          "info": {
            "name": "Create contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.lawvu.com/account-apis/v1/contracts/wizard",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new contract, using the contract template wizard"
        }
      ]
    }
  ],
  "bundled": true
}