{
  "opencollection": "1.0.0",
  "info": {
    "name": "Luminance Folders API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Folders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Folder Collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/projects/:project-id/folders",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of objects that can be retrieved."
              },
              {
                "name": "project-id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query",
                "description": "The folder Id of the Parent Folder"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of Folder"
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Current State of Folder"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Folder type"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://moniker.app.luminance.com/auth/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get Folder Collection"
        },
        {
          "info": {
            "name": "Create a folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{moniker}.app.luminance.com/projects/:project-id/folders",
            "params": [
              {
                "name": "project-id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://moniker.app.luminance.com/auth/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a folder"
        },
        {
          "info": {
            "name": "Patch information on a Folder Collection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{moniker}.app.luminance.com/projects/:project-id/folders",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of objects that can be retrieved."
              },
              {
                "name": "project-id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query",
                "description": "The folder Id of the Parent Folder"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of Folder"
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Current State of Folder"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Folder type"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://moniker.app.luminance.com/auth/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Patch information on a Folder Collection"
        },
        {
          "info": {
            "name": "Get Information on a Single Folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/projects/:project-id/folders/:folder-id",
            "params": [
              {
                "name": "folder-id",
                "value": "",
                "type": "path",
                "description": "Folder ID"
              },
              {
                "name": "project-id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://moniker.app.luminance.com/auth/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get Information on a Single Folder"
        },
        {
          "info": {
            "name": "Modify Information on a Single Folder",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{moniker}.app.luminance.com/projects/:project-id/folders/:folder-id",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of objects that can be retrieved."
              },
              {
                "name": "folder-id",
                "value": "",
                "type": "path",
                "description": "Folder ID"
              },
              {
                "name": "project-id",
                "value": "",
                "type": "path",
                "description": "Project ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://moniker.app.luminance.com/auth/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Modify Information on a Single Folder"
        },
        {
          "info": {
            "name": "List folders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List folders"
        },
        {
          "info": {
            "name": "Create folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create folder"
        },
        {
          "info": {
            "name": "Update folders by filter",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update folders by filter"
        },
        {
          "info": {
            "name": "Delete folders by filter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "parent_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete folders by filter"
        },
        {
          "info": {
            "name": "Get folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get folder"
        },
        {
          "info": {
            "name": "Update folder",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update folder"
        },
        {
          "info": {
            "name": "Delete folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete folder"
        },
        {
          "info": {
            "name": "Upload a document into a folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/upload",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "replace",
                "value": "",
                "type": "query"
              },
              {
                "name": "matter_version_type",
                "value": "",
                "type": "query"
              },
              {
                "name": "matter_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "task_id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Body must be a base64-encoded file. See query params for metadata."
        },
        {
          "info": {
            "name": "List documents in folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List documents in folder"
        },
        {
          "info": {
            "name": "Delete documents in folder by filter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete documents in folder by filter"
        },
        {
          "info": {
            "name": "Get document in folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents/:document_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get document in folder"
        },
        {
          "info": {
            "name": "Delete document in folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents/:document_id",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete document in folder"
        },
        {
          "info": {
            "name": "List document annotations (folder-scoped path)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents/:document_id/annotations",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List document annotations (folder-scoped path)"
        },
        {
          "info": {
            "name": "Retrieve annotation text (folder-scoped path)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents/:document_id/annotations/annotationText",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "fullParagraph",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve annotation text (folder-scoped path)"
        },
        {
          "info": {
            "name": "Download document file (folder-scoped path)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{moniker}.app.luminance.com/api2/projects/:project_id/folders/:folder_id/documents/:document_id/download",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "enable_token_linking",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Download document file (folder-scoped path)"
        }
      ]
    }
  ],
  "bundled": true
}