Retrieve Documents

This API endpoint retrieves a list of documents associated with a specific company.

Request

• Method: GET

• URL: https://app.investglass.com/api/v1/documents

• Query Parameters:

  • document[directory_path] (string): Specifies the directory path for the document.

  • ancestry_folder (string): Specifies the ancestry folder for the document.

  • page (integer): Specifies the page number for paginated results.

  • limit (integer): Specifies the maximum number of items to return per page.

  • order[column] (string): Specifies the column for sorting the results.

  • order[direction] (string): Specifies the sorting direction (e.g., "asc" or "desc").

  • filter[column] (string): Specifies the column to filter the results.

Response

The response will contain the following arrays:

• folders: Array of folder objects with details such as id, folder name, company ID, creation and update timestamps, ancestry, client ID, sharing status, creator and modifier IDs, notification preferences, and client type.

• forms: Array of form objects with details such as id, title, company ID, publish status, creator and modifier IDs, URL, and creation and update timestamps.

• documents: Array of document objects with details such as id, user and company IDs, client ID, description, original filename, content type, size, approver ID, approval timestamp, read status, document type, updater ID, directory path, expiration date, creator and modifier IDs, tags, document status, creation and update timestamps, package, and URL.

Example

{
  "folders": [
    {
      "id": "",
      "folder_name": "",
      "company_id": "",
      "created_at": "",
      "updated_at": "",
      "ancestry": "",
      "client_id": "",
      "share_on_client_portal": "",
      "creator_id": "",
      "last_modifier_id": "",
      "notify_by_email": "",
      "client_type": ""
    }
  ],
  "forms": [
    {
      "id": "",
      "title": "",
      "company_id": "",
      "publish": "",
      "creator_id": "",
      "last_modifier_id": "",
      "url": "",
      "created_at": "",
      "updated_at": ""
    }
  ],
  "documents": [
    {
      "id": "",
      "user_id": "",
      "company_id": "",
      "client_id": "",
      "description": "",
      "original_filename": "",
      "content_type": "",
      "size": "",
      "approver_id": "",
      "approved_at": "",
      "is_read": "",
      "document_type": "",
      "updater_id": "",
      "directory_path": "",
      "expiration_date": "",
      "creator_id": "",
      "last_modifier_id": "",
      "tags": [""],
      "document_status": "",
      "created_at": "",
      "updated_at": "",
      "package": "",
      "url": ""
    }
  ]
}