View Categories

Envelope list

This section describes how to retrieve a list of envelopes using the Signatus 2 API. It explains how to query envelopes based on their status or other criteria in order to monitor, manage, and track document workflows.

Retrieves detailed information about envelopes according to the search criteria

Service specifications: #

URL/api/envelope/list
MethodGET
AuthenticationBearer access token
Response typeapplication/json

Request description #

Request parameters:

KeyTypeDescription
createdFromqueryEnvelope created from. Datetime in dd.MM.yyyy’T’HH:mm format
For example :
01.08.2024T08:00
createdToqueryEnvelope created to. Datetime in dd.MM.yyyy’T’HH:mm format
For example :
31.08.2024T23:59
typequeryEnvelope type
archivequeryDetermines whether to search for the envelope in the archive.
– true
– false
Default : false
HTTP- Click to view HTTP code snippet 
GET /app/api/envelope/list?createdFrom=23.07.2025T12:30&createdTo=26.07.2025T12:30&type=menu1&archive=false HTTP/1.1
Host: signatus.ana.sk
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJTGNWSnp4SFkyd1RDcGlLZU5Oa2VmbWZHa1ljUnBtQ1lMMUhsNG13Zm5VIn0.eyJleHAiOjE3NTM5NTIzNzEsImlhdCI6MTc1Mzk1MjA3MSwianRpIjoiYWI1YTJlYmEtNTZkZi00Y2ZkLTkyOGYtMTU3ZWMyYzU1N2RlIiwiaXNzIjoiaHR0cHM6Ly9vYXV0aC5hbmEuc2svcmVhbG1zL1NpZ25hdHVzIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImYzYmUxYTY2LTU1M2YtNGFlOC04OTUyLTY3OGQ4NTU2ZDAxYiIsInR5cCI6IkJlYXJlciIsImF6cCI6InNpZ25hdHVzIiwic2lkIjoiYTczMTkzMmItOTAyNC00ZWU5LWFlOTEtNWZlNTJmYWIzNjliIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyIvKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiUk9MRV9QUk9YWSIsImRlZmF1bHQtcm9sZXMtc2lnbmF0dXMiLCJST0xFX1BPUlRBTCIsIlJPTEVfVVNFUiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicGhvbmUgZ3JvdXBzIHRlbmFudGlkIHByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInRlbmFudGlkIjoiZGVtbyIsIm5hbWUiOiJQYXZvbCBQdW5hIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiZGVtby5hcGkiLCJnaXZlbl9uYW1lIjoiUGF2b2wiLCJmYW1pbHlfbmFtZSI6IlB1bmEiLCJlbWFpbCI6InBhdm9sLnB1bmFAYW5hc29mdC5jb20ifQ.PP-jqR34m5dLEzpLNKK0hgk2PM9L3Q2WqR9aZjFRRG7mPZJ538gqlyh9WZU8R33njAjIq6Uo4Ty8qTrwGgRrpqnA8lVRvPnKimLzN8qDmAzBE29JxitQ3AYLC4VFpvp2zU0WTugypE84X1Km3Dd5O8efhDe2M41LNtsaT1ys2Y8qZb6dZVkTOexQ2YAqycCE4TCD1bPXYRQzI2miiuiz2Ik0KK-3ommk7C4JM83jw1ZxZF3ZLka7xmILxKZcHqIkahPDltmF-yxox5yPKIwnbbgvu8M8oqgsZp33fEH-6I4p8jInzymDseYze0O0hDdHzb58aV-cmoDXb5YBQ5VDtQ

Response description #

Status codeDescription
200 OKEnvelope list
401 UnauthorizedWhen user is not authenticated
403 ForbiddenWhen user lacks required permissions
404 Not FoundIf the envelope with the specified id does not exist.
500 Internal Server ErrorServer processing error

Success response example :

[
    {
        "id": "387e81d6-e1c9-4f78-8e03-526f51bfd1ee",
        "userId": "demo.api",
        "created": 1753434255469,
        "updated": 1753434255469,
        "state": "ready",
        "envelopetypeid": 4,
        "expirationtime": 1830395240000,
        "extension": {},
        "type": "menu1",
        "product": [],
        "contact": {},
        "tenant": "demo",
        "rules": {
            "lang": "en",
            "resulturl": "https://signatus.com"
        }
    },
    {
        "id": "157cc4bd-7955-49e4-9832-b5afa9838076",
        "userId": "demo.api",
        "created": 1753434207809,
        "updated": 1753434207809,
        "state": "ready",
        "envelopetypeid": 4,
        "expirationtime": 1830395240000,
        "extension": {},
        "type": "menu1",
        "product": [],
        "contact": {},
        "tenant": "demo",
        "rules": {
            "lang": "en",
            "resulturl": "https://signatus.com"
        }
    }
]

Error response example :

{
    "message": "err.envelope.load",
    "value": ""
}