List

Overview

You can get Smart Document list assigned to you or shared with you by using this API.

API detail

Request

• URL: /smart-documents/
• Method: GET
• Query Params:

{
  "page": 1,
  "page_size": 10,
}

Response

Success

• Status code: 200
• Body:

{
  "count": 8,
  "next": "https://api.legale.io/api/v2/smart-documents/?page=2&page_size=10",
  "previous": null,
  "results": [
    {
      "id": 1,
      "items": [
        {
          "id": 7185,
          "name": "Email",
          "type": "text",
          "format": "email",
          "item_number": 1,
          "col_span": 24,
          "is_required": true,
          "is_conditional_visible": false,
          "is_hidden": false,
          "extra_data": {}
        },
        {
          "id": 7185,
          "name": "Name",
          "type": "text",
          "format": null,
          "item_number": 2,
          "col_span": 24,
          "is_required": true,
          "is_conditional_visible": false,
          "is_hidden": false,
          "extra_data": {}
        },
      ],
      "name": "Contract",
      "content": "<p>Test</p>\n<p>Test2</p>",
      "preview": "https://api.legale.io/media/smart_template_preview/1747406601055.pdf",
      "callback_url": null,
      "created_at": "2025-05-16T14:43:13.530324Z",
      "updated_at": "2025-05-16T14:43:21.152950Z",
      "owner": "owner@gmail.com",
      "users": [
          "owner@gmail.com",
          "shared.user@gmail.com"
      ]
    },
  ],
}
...

• smart_document_item

Value	Type	Description
id	int	ID of model instance in DB.
name	str	Name of smart document item.
type	str	Data type of smart document item. Such as text, number...
format	str	Data value format for some specific types of items, such as number, date...
item_number	int	Unique index of smart document item, starts from 1
col_span	int	Grid Column number of the item in UI
is_required	bool	Item field is required or not in form.
is_conditional_visible	bool	Field is conditional visible in form UI, conditional details will be in extra_data
is_hidden	bool	Field is hidden field in form UI
extra_data	json	All extra information related to item such as condition, formula...