{
  "opencollection": "1.0.0",
  "info": {
    "name": "Smokeball Activity Codes Matters API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-api-key",
      "value": "{{x-api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Matters",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the archive for a matter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/matters/:matterId/archive",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves an archive for a matter."
        },
        {
          "info": {
            "name": "Update an archive for a matter.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.smokeball.com/matters/:matterId/archive",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a specified matter's archive"
        },
        {
          "info": {
            "name": "Patch an archive for a matter",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.smokeball.com/matters/:matterId/archive",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a specified matter's archive with patch operations."
        },
        {
          "info": {
            "name": "Get matter billing configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/matters/:matterId/billingconfiguration",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves the billing configuration for the specified matter."
        },
        {
          "info": {
            "name": "Update matter billing configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.smokeball.com/matters/:matterId/billingconfiguration",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the billing configuration for the specified matter."
        },
        {
          "info": {
            "name": "Get matters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/matters",
            "params": [
              {
                "name": "Offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "Limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "Search",
                "value": "Bob",
                "type": "query",
                "description": "Filter matters by specified search term.\r\nThis field is wide reaching, it is used to search by clients, othersides, description and matter numbers."
              },
              {
                "name": "MatterTypeId",
                "value": "009f778f-83df-454a-b344-768a862a7e55",
                "type": "query",
                "description": "Filter by matter type identifier."
              },
              {
                "name": "ContactId",
                "value": "7fdbdd5b-0f5e-4095-af9e-ae5b055325c7",
                "type": "query",
                "description": "Filter by the contact identifier."
              },
              {
                "name": "Status",
                "value": "",
                "type": "query",
                "description": "Filter by current status of the matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled."
              },
              {
                "name": "IsLead",
                "value": "true",
                "type": "query",
                "description": "Boolean flag to return 'Leads'. This is false by default.\r\n\r\nA Lead is a potential matter that has not yet been converted to a full matter. The data structure of a lead is similar to a matter, but with some small variances."
              },
              {
                "name": "Type",
                "value": "Leads",
                "type": "query",
                "description": "Type of matter to search for. This is set to Matters by default. \r\n            \r\nA Lead is a potential matter that has not yet been converted to a full matter. The data structure of a lead is similar to a matter, but with some small variances.\r\n            \r\nPossible values: \"Matters\", \"Leads\", \"Matters,Leads\"."
              },
              {
                "name": "UpdatedSince",
                "value": "637873555398585000",
                "type": "query",
                "description": "Filter by matters updated since a specified time (.net ticks representation of the UTC datetime). Cannot be used in conjunction with `LastUpdated`.\r\n\r\nThis field will not be supported in future, please use LastUpdated instead."
              },
              {
                "name": "LastUpdated",
                "value": "2022-04-23T14:00:00Z",
                "type": "query",
                "description": "Filter by last updated date of matter. Cannot be used in conjunction with `UpdatedSince`."
              },
              {
                "name": "Sort",
                "value": "",
                "type": "query",
                "description": " Available fields: status, lastUpdated"
              },
              {
                "name": "Fields",
                "value": "",
                "type": "query",
                "description": " Available fields: items, tags"
              }
            ]
          },
          "docs": "Returns a list of matters. To return leads, set the `isLead` search option to true."
        },
        {
          "info": {
            "name": "Create a matter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.smokeball.com/matters",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new matter.\r\n            \r\nNote: This endpoint can also be used to create a `Lead`.\r\n\r\nWhen creating a `Lead` you MUST remember to set a valid lead specific `matterTypeId` field (see field description below for more details) and set the `isLead` field to true.\r\n\r\nThe `clientRole` and `otherSideRole` are optional and cannot be identical. They will be set to the default role(s) for the specified matter type - if not provided."
        },
        {
          "info": {
            "name": "Get a matter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/matters/:matterId",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a specified matter."
        },
        {
          "info": {
            "name": "Update a matter",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.smokeball.com/matters/:matterId",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a specified matter.\r\n            \r\nThe following actions are currently not supported:\r\n            \r\n- `clientIds` cannot be modified\r\n            \r\n- `otherSideIds` cannot be modified\r\n\r\n-  `Matter` cannot be converted back to `Lead`"
        },
        {
          "info": {
            "name": "Patch a matter",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.smokeball.com/matters/:matterId",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Patches a specified matter.\r\n            \r\nNote: This endpoint can also be used to update a `Lead`, convert `Lead` to `Matter` and change the `Lead`/`Matter` type.\r\n            \r\nSee `Matters` documentation for more details on how to use this.\r\n\r\nThe following actions are not supported:\r\n\r\n- `items` cannot be updated where either `clientIds` and/or `otherSideIds` are being updated\r\n            \r\n- `items` cannot be updated when converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type"
        },
        {
          "info": {
            "name": "Delete a matter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.smokeball.com/matters/:matterId",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes a specified matter."
        },
        {
          "info": {
            "name": "Get matter tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.smokeball.com/matters/:matterId/tags",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get matter tags"
        },
        {
          "info": {
            "name": "Add tags to a matter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.smokeball.com/matters/:matterId/tags",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add tags to a matter"
        },
        {
          "info": {
            "name": "Remove tags from a matter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.smokeball.com/matters/:matterId/tags/:tagId",
            "params": [
              {
                "name": "matterId",
                "value": "",
                "type": "path"
              },
              {
                "name": "tagId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Removes the tag from the matter without deleting from the account."
        }
      ]
    }
  ],
  "bundled": true
}