---
updatedAt: 2026-08-18T12:58:46.000Z
agentTools:
  projectIndex: https://bolosign-developer-docs.readme.io/llms.txt
---

# Getting Started

Set up the welcome page for your API to help users make their first call.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "open api for boloforms signature product",
    "version": "2024-08-14T06:43:34Z",
    "title": "BoloForms Signature API"
  },
  "servers": [
    {
      "url": "https://sapi.boloforms.com/signature"
    }
  ],
  "paths": {
    "/get-documents": {
      "get": {
        "summary": "Getting Started",
        "description": "Set up the welcome page for your API to help users make their first call.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Search query for filtering documents"
          },
          {
            "name": "sortOrder",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Sort order (asc/desc)"
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Number of documents per page"
          },
          {
            "name": "documentId",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Specific document ID to retrieve"
          },
          {
            "name": "dateTo",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "End date for filtering documents"
          },
          {
            "name": "dateFrom",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Start date for filtering documents"
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Page number for pagination"
          },
          {
            "name": "sortBy",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Field to sort by"
          },
          {
            "name": "filter",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Additional filtering criteria"
          },
          {
            "name": "workspaceid",
            "required": true,
            "in": "header",
            "schema": {
              "type": "string"
            },
            "description": "Workspace ID for filtering documents"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved documents",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentsResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - API key is missing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-internal": false
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "error": {
            "type": "string",
            "description": "Detailed error information"
          }
        }
      },
      "DocumentsResponse": {
        "type": "object",
        "properties": {
          "documents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "documentId": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time"
                },
                "status": {
                  "type": "string"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "currentPage": {
                "type": "integer"
              },
              "totalPages": {
                "type": "integer"
              },
              "totalDocuments": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```