Folders and document placement (folder_id) (API)

Modified on Sat, 3 Oct at 2:54 PM

You can place a document into a folder in the workspace right when creating it. Folders and labels are a single system in Signi — a folder is a label with "is_folder": true.

Creating a folder

curl -X POST -H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
  https://api.signi.com/api/v1/tags/create \
  -d '{ "name": "Orders 2026", "is_folder": true }'

The ID of the new folder (a number) is returned. You can find existing folders in the list of labels — folders have "is_folder": true.

Placing a document into a folder

When creating a document, add folder_id:

{
    "people": [
        { "is_proposer": true, "email": "your@email.com", "contract_role": "approve" },
        { "is_proposer": false, "email": "counterparty@email.com", "contract_role": "sign",
          "first_name": "Jan", "last_name": "Novák", "person_type": "nature",
          "positions": [ { "x": 50, "y": 80, "page": 0 } ] }
    ],
    "folder_id": 123,
    "file": "uploaded_file_key"
}

Caution: a non-existent folder_id does not return an error — the document is created and the placement is silently skipped. Verify the folder ID in the list of labels.

Where to go next

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article