Tags (API)

Tags help you sort documents within a workspace. Via the API you can list them, create them, and assign them to a document when it's created.

Tags and folders are one and the same system — a folder is a tag with "is_folder": true. Placing a document into a folder is described in the article Folders and placing a document.

Listing tags

curl -H "x-api-key: YOUR_API_KEY" https://api.signi.com/api/v1/tags/list

[
    { "id": 123, "name": "Smlouvy", "workspace": { "id": 12345, "name": "Demo" }, "is_folder": false }
]

Creating a tag

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": "Smlouvy", "is_folder": false }'

The ID of the new tag (a number) is returned. The same name cannot be used twice.

Note: the is_folder field is required — without it the call will fail. false = tag, true = folder. Deleting a tag via the API is not yet possible.

A document with a tag

Tags are assigned to a document when it's created — using the tags field with a list of IDs:

{
    "people": [ … who signs … ],
    "file": "uploaded_file_key",
    "tags": [123]
}

You'll see that the tag was assigned in the document detail:

{ "contract_id": "1234567", "state": "pending", "tags": [ { "id": 123, "name": "Smlouvy" } ] }

Where to go next

• Folders and placing a document
• Contacts
• Quickstart — your first document to sign via the API