Folders

Los endpoints de Folders te permiten organizar documentos en una estructura jerárquica de carpetas. Puedes crear, listar, renombrar, mover y eliminar carpetas.

GET/v2/folders

List folders

Obtén todas las carpetas del usuario en estructura de árbol (tree).

Query parameters

Name
scope
Type
string
Description
Alcance: owner (default), org, tenant, accessible.

Request

GET

/v2/folders

curl "https://api.allsign.io/v2/folders" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK"

Response (200)

{
  "success": true,
  "message": "Folders retrieved successfully",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Documentos",
      "ownerId": "550e8400-e29b-41d4-a716-446655440001",
      "parentId": null,
      "createdAt": "2024-11-23T10:00:00Z",
      "updatedAt": "2024-11-23T10:00:00Z",
      "hasDocs": true,
      "isMain": true,
      "subfolders": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440002",
          "name": "Contratos",
          "ownerId": "550e8400-e29b-41d4-a716-446655440001",
          "parentId": "550e8400-e29b-41d4-a716-446655440000",
          "createdAt": "2024-11-23T10:00:00Z",
          "updatedAt": "2024-11-23T10:00:00Z",
          "hasDocs": false,
          "isMain": false,
          "subfolders": []
        }
      ]
    }
  ]
}

POST/v2/folders

Create folder

Crea una nueva carpeta.

Request body

Name
name
Type
string
Description
Nombre de la carpeta (1-255 caracteres).
Name
parentId
Type
string
Description
ID de la carpeta padre. null = nivel raíz.

Request

POST

/v2/folders

curl -X POST "https://api.allsign.io/v2/folders" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK" \
  -H "Content-Type: application/json" \
  -d '{"name": "Facturas 2025", "parentId": null}'

Response (201)

{
  "id": "550e8400-e29b-41d4-a716-446655440003",
  "name": "Facturas 2025",
  "ownerId": "550e8400-e29b-41d4-a716-446655440001",
  "parentId": null,
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T10:00:00Z",
  "hasDocs": false,
  "isMain": false
}

GET/v2/folders/{folder_id}

Get folder

Obtén los detalles de una carpeta específica.

Path parameters

Name
folder_id
Type
string
Description
ID de la carpeta (UUID).

PATCH/v2/folders/{folder_id}

Update folder

Renombra o mueve una carpeta.

Request body

Name
name
Type
string
Description
Nuevo nombre de la carpeta.
Name
parentId
Type
string
Description
Nuevo ID de carpeta padre (para mover la carpeta).

Request

PATCH

/v2/folders/{folder_id}

curl -X PATCH "https://api.allsign.io/v2/folders/FOLDER_UUID" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK" \
  -H "Content-Type: application/json" \
  -d '{"name": "Contratos 2025"}'

No puedes mover una carpeta dentro de sí misma ni dentro de sus subcarpetas. Si se detecta una referencia circular, la API devuelve 400 Bad Request.

DELETE/v2/folders/{folder_id}

Delete folder

Elimina una carpeta. Falla si contiene documentos o subcarpetas.

Path parameters

Name
folder_id
Type
string
Description
ID de la carpeta (UUID).

curl -X DELETE "https://api.allsign.io/v2/folders/FOLDER_UUID" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK"

Responde con 204 No Content si se elimina exitosamente.

GET/v2/folders/{folder_id}/documents

Get documents in folder

Obtén todos los documentos dentro de una carpeta. Es un alias conveniente de GET /v2/documents?folderId={folder_id}.

Query parameters

Name
limit
Type
integer
Description
Resultados por página (1-100, default: 10).
Name
page
Type
integer
Description
Número de página (1-10000).

curl "https://api.allsign.io/v2/folders/FOLDER_UUID/documents?limit=20" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK"