API Reference
Log In
API Reference
  1. BoloForms Signature API
  2. Documents

Get documents list

get
https://sapi.boloforms.com/signature/get-documents

Retrieve documents for a workspace, with optional filtering and pagination.

A document is either a single signature PDF (documentType=PDF) or a PDF template (documentType=PDF_TEMPLATE). Both types are supported; set documentType to choose which list to return. Default is PDF.

Results are always sorted by createdAt. Use sortOrder for ascending or descending (default: newest first).

Supported filters: documentType, status (PDF only), documentId, dateFrom / dateTo (createdAt range), and archive. Maximum limit is 100.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
length between 3 and 12
^(PDF|PDF_TEMPLATE)$

Which documents to list. PDF = single signature PDFs. PDF_TEMPLATE = PDF templates. Both are supported.

Allowed:
string
enum
length between 3 and 13
^(ALL|DRAFT|SENT|SIGNED|COMPLETED|DECLINED|EXPIRED|CANCELLED|VOID|TEMPLATE|DELETED|UNPAID|PAID|SENT VIA LINK)$

Document status filter. Only supported for documentType=PDF. Use ALL to skip status filtering. Encode SENT VIA LINK as SENT%20VIA%20LINK.

string
enum
length between 3 and 4
^(asc|desc)$
Defaults to desc

Sort direction for createdAt (asc or desc). Sort field is always createdAt. Defaults to newest first (desc).

Allowed:
int32
1 to 100
Defaults to 10

Number of documents per page

int32
1 to 10000
Defaults to 1

Page number for pagination

uuid
length between 36 and 36
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Specific document ID to retrieve. Works for both a single signature PDF UUID and a PDF template UUID (pair with documentType).

date
length between 10 and 10
^\d{4}-\d{2}-\d{2}$

Inclusive start of the createdAt range. Format: YYYY-MM-DD.

date
length between 10 and 10
^\d{4}-\d{2}-\d{2}$

Inclusive end of the createdAt range. Format: YYYY-MM-DD.

string
enum
length between 4 and 5
^(true|false)$
Defaults to false

Archived files flag. true returns archived documents only; false (default) excludes them.

Allowed:
Headers
uuid
required
length between 36 and 36
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Workspace ID for filtering documents. Header name is case-insensitive (workspaceid or workspaceId).

Responses

Updated 4 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?