API reference

Folders

Group documents in folders, shared across the workspace.

Endpoints · 6

POST Create a folder
GET Retrieve a folder
GET List folders
PATCH Rename a folder
DELETE Delete a folder
POST Move documents into a folder

The object

Field	Type	Description
`id`	string	Unique ID, starting with fdr_.
`object`	string	Always "folder".
`name`	string	Unique in the workspace.
`document_count`	integer	Documents in the folder.
`created_at`	timestamp

POST/folders

Create a folder

Parameter	Type		Description
`name`	string	required	Up to 80 characters.

Request

bash

curl -X POST "https://api.esorasign.com/v1/folders" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Client contracts" }'

Response

json

{
  "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
  "object": "folder",
  "name": "Client contracts",
  "document_count": 0,
  "created_at": "2026-08-04T09:00:12.000Z"
}

GET/folders/{id}

Retrieve a folder

Request

bash

curl "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{
  "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
  "object": "folder",
  "name": "Client contracts",
  "document_count": 14,
  "created_at": "2026-08-04T09:00:12.000Z"
}

GET/folders

List folders

Newest first.

Parameter	Type		Description
`limit`	integer	optional	How many objects to return, 1 to 100. Default 20.
`starting_after`	string	optional	The next_cursor from the previous page. Leave it out for the first page.

Request

bash

curl "https://api.esorasign.com/v1/folders" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{
  "object": "list",
  "data": [
    {
      "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
      "object": "folder",
      "name": "Client contracts",
      "document_count": 14,
      "created_at": "2026-08-04T09:00:12.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

PATCH/folders/{id}

Rename a folder

Parameter	Type		Description
`name`	string	required

Request

bash

curl -X PATCH "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Clients" }'

Response

json

{
  "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
  "object": "folder",
  "name": "Client contracts",
  "document_count": 14,
  "created_at": "2026-08-04T09:00:12.000Z"
}

DELETE/folders/{id}

Delete a folder

Its documents are kept and move out of the folder.

Request

bash

curl -X DELETE "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{ "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS", "object": "folder", "deleted": true }

POST/folders/{id}/documents

Move documents into a folder

Parameter	Type		Description
`document_ids`	array	required	1 to 100 document IDs.

Request

bash

curl -X POST "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS/documents" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "document_ids": ["doc_3y9Pf34qY6Nb3wWD25RQ4F"] }'

Response

json

{ "object": "folder_move", "folder_id": "fdr_6TMAd7V3DnI8lFPPwtV5AS", "moved": 1 }