Folders — Endpoints API v3 de AllSign

El objeto Folder

Atributos

livemode boolean requerido

true en entorno live, false en test/dev (marca de agua, sin validez legal).
id string requerido

ID de la carpeta (fld_…).
object string, siempre "folder"

Siempre "folder".
name string requerido

Nombre de la carpeta.
ownerId string requerido

Dueño de la carpeta (usr_…).
parentId string puede ser null

Carpeta padre (fld_…), o null si está en la raíz.
hasDocs boolean requerido

Si la carpeta contiene al menos un documento.
isMain boolean requerido

Si es la carpeta principal (raíz) del usuario.
createdAt string (fecha-hora ISO 8601) requerido

Fecha de creación (ISO 8601).
updatedAt string (fecha-hora ISO 8601) requerido

Última actualización (ISO 8601).

El objeto Folder

{
  "livemode": false,
  "id": "fld_c1c3fb2ea6634f929addda83f073a00c",
  "object": "folder",
  "name": "v3audit-ejemplos Clientes",
  "ownerId": "usr_beadaffd52b943749b179fded8733b31",
  "parentId": null,
  "hasDocs": false,
  "isMain": false,
  "createdAt": "2026-07-11T18:00:00.000000Z",
  "updatedAt": "2026-07-11T18:00:00.000000Z"
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts

List folders

GET /folders

Lista tus carpetas con paginación por cursor.

Parámetros

limit integer query

Resultados por página (1–100, default 20).

default 20 · entre 1 y 100
startingAfter string query

Cursor: carpetas después de este id (fld_…).
endingBefore string query

Cursor: carpetas antes de este id (fld_…).
sort enum query

Orden por fecha de creación: createdAt o -createdAt (default -createdAt).

Valores: createdAt -createdAt
AllSign-Version enum header

Fecha del contrato contra la que quieres resolver la petición. Si la omites se sirve la versión vigente; una fecha desconocida responde 400 UNSUPPORTED_API_VERSION.

Valores: 2026-07-11

Devuelve

200 Sobre de paginación por cursor (object: "list") con objetos Folder.

Ver los 6 atributos de la respuesta

object string, siempre "list"

Siempre "list".
data array de objetos requerido

Arreglo de objetos Folder.
Ver 10 atributos hijos
- data[].livemode boolean requerido
  
  true en entorno live, false en test/dev (marca de agua, sin validez legal).
- data[].id string requerido
  
  ID de la carpeta (fld_…).
- data[].object string, siempre "folder"
  
  Siempre "folder".
- data[].name string requerido
  
  Nombre de la carpeta.
- data[].ownerId string requerido
  
  Dueño de la carpeta (usr_…).
- data[].parentId string puede ser null
  
  Carpeta padre (fld_…), o null si está en la raíz.
- data[].hasDocs boolean requerido
  
  Si la carpeta contiene al menos un documento.
- data[].isMain boolean requerido
  
  Si es la carpeta principal (raíz) del usuario.
- data[].createdAt string (fecha-hora ISO 8601) requerido
  
  Fecha de creación (ISO 8601).
- data[].updatedAt string (fecha-hora ISO 8601) requerido
  
  Última actualización (ISO 8601).
hasMore boolean requerido

true si hay más resultados después de esta página.
nextCursor string puede ser null

Cursor para la siguiente página (pásalo como startingAfter).
previousCursor string puede ser null

Cursor para la página anterior (pásalo como endingBefore).
limit integer requerido

El límite aplicado a esta página.

Errores posibles (problem+json): 400 401 403 422 429

cURL

curl 'https://api.allsign.io/v3/folders?limit=5' \
  -H "Authorization: Bearer $ALLSIGN_API_KEY" \
  -H "AllSign-Version: 2026-07-11"

Node

const respuesta = await fetch('https://api.allsign.io/v3/folders?limit=5', {
    headers: {
        Authorization: `Bearer ${process.env.ALLSIGN_API_KEY}`,
        'AllSign-Version': '2026-07-11',
    },
});
console.log(respuesta.status, await respuesta.json());

Python

import os

import requests

respuesta = requests.get(
    "https://api.allsign.io/v3/folders?limit=5",
    headers={
        "Authorization": f"Bearer {os.environ['ALLSIGN_API_KEY']}",
        "AllSign-Version": "2026-07-11",
    },
)
print(respuesta.status_code, respuesta.json())

Respuesta · 200

{
  "object": "list",
  "data": [
    {
      "livemode": false,
      "id": "fld_14bc58afe3634831bf82928332c1ab86",
      "object": "folder",
      "name": "v3audit-ejemplos Contratos 2026",
      "ownerId": "usr_beadaffd52b943749b179fded8733b31",
      "parentId": "fld_c1c3fb2ea6634f929addda83f073a00c",
      "hasDocs": false,
      "isMain": false,
      "createdAt": "2026-07-11T18:00:00.441000Z",
      "updatedAt": "2026-07-11T18:00:00.441000Z"
    },
    {
      "livemode": false,
      "id": "fld_c1c3fb2ea6634f929addda83f073a00c",
      "object": "folder",
      "name": "v3audit-ejemplos Clientes",
      "ownerId": "usr_beadaffd52b943749b179fded8733b31",
      "parentId": null,
      "hasDocs": false,
      "isMain": false,
      "createdAt": "2026-07-11T18:00:00.000000Z",
      "updatedAt": "2026-07-11T18:00:00.000000Z"
    },
    {
      "livemode": false,
      "id": "fld_44390d30ef9744ada77750fa1c9a1a9b",
      "object": "folder",
      "name": "v3audit-contrato cursor 293a3238",
      "ownerId": "usr_beadaffd52b943749b179fded8733b31",
      "parentId": null,
      "hasDocs": true,
      "isMain": false,
      "createdAt": "2026-07-11T12:45:17.060000Z",
      "updatedAt": "2026-07-11T12:45:17.060000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null,
  "previousCursor": null,
  "limit": 5
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts

Create folder

POST /folders

Crea una carpeta. Puedes anidarla pasando un parentId; si lo omites (o mandas null), la carpeta queda a nivel raíz.

Parámetros

AllSign-Version enum header

Fecha del contrato contra la que quieres resolver la petición. Si la omites se sirve la versión vigente; una fecha desconocida responde 400 UNSUPPORTED_API_VERSION.

Valores: 2026-07-11

Cuerpo de la petición

application/json

name string requerido

Nombre de la carpeta.
parentId string puede ser null

Carpeta padre (fld_…) para anidar. null u omitido = nivel raíz.

Devuelve

201 El objeto Folder creado. — el objeto Folder

Errores posibles (problem+json): 400 401 403 404 422 429

cURL

curl -X POST 'https://api.allsign.io/v3/folders' \
  -H "Authorization: Bearer $ALLSIGN_API_KEY" \
  -H "AllSign-Version: 2026-07-11" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "v3audit-ejemplos Clientes"
}'

Node

const respuesta = await fetch('https://api.allsign.io/v3/folders', {
    method: 'POST',
    headers: {
        Authorization: `Bearer ${process.env.ALLSIGN_API_KEY}`,
        'AllSign-Version': '2026-07-11',
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        name: 'v3audit-ejemplos Clientes',
    }),
});
console.log(respuesta.status, await respuesta.json());

Python

import os

import requests

respuesta = requests.post(
    "https://api.allsign.io/v3/folders",
    headers={
        "Authorization": f"Bearer {os.environ['ALLSIGN_API_KEY']}",
        "AllSign-Version": "2026-07-11",
    },
    json={
        "name": "v3audit-ejemplos Clientes",
    },
)
print(respuesta.status_code, respuesta.json())

Respuesta · 201

{
  "livemode": false,
  "id": "fld_c1c3fb2ea6634f929addda83f073a00c",
  "object": "folder",
  "name": "v3audit-ejemplos Clientes",
  "ownerId": "usr_beadaffd52b943749b179fded8733b31",
  "parentId": null,
  "hasDocs": false,
  "isMain": false,
  "createdAt": "2026-07-11T18:00:00.000000Z",
  "updatedAt": "2026-07-11T18:00:00.000000Z"
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts

Retrieve folder

GET /folders/{folder_id}

Consulta una carpeta por su id.

Parámetros

folder_id string ruta requerido

ID de la carpeta (fld_…).
AllSign-Version enum header

Fecha del contrato contra la que quieres resolver la petición. Si la omites se sirve la versión vigente; una fecha desconocida responde 400 UNSUPPORTED_API_VERSION.

Valores: 2026-07-11

Devuelve

200 El objeto Folder. — el objeto Folder

Errores posibles (problem+json): 400 401 403 404 422 429

cURL

curl 'https://api.allsign.io/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c' \
  -H "Authorization: Bearer $ALLSIGN_API_KEY" \
  -H "AllSign-Version: 2026-07-11"

Node

const respuesta = await fetch('https://api.allsign.io/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c', {
    headers: {
        Authorization: `Bearer ${process.env.ALLSIGN_API_KEY}`,
        'AllSign-Version': '2026-07-11',
    },
});
console.log(respuesta.status, await respuesta.json());

Python

import os

import requests

respuesta = requests.get(
    "https://api.allsign.io/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c",
    headers={
        "Authorization": f"Bearer {os.environ['ALLSIGN_API_KEY']}",
        "AllSign-Version": "2026-07-11",
    },
)
print(respuesta.status_code, respuesta.json())

Respuesta

Respuesta · 200

{
  "livemode": false,
  "id": "fld_c1c3fb2ea6634f929addda83f073a00c",
  "object": "folder",
  "name": "v3audit-ejemplos Clientes",
  "ownerId": "usr_beadaffd52b943749b179fded8733b31",
  "parentId": null,
  "hasDocs": false,
  "isMain": false,
  "createdAt": "2026-07-11T18:00:00.000000Z",
  "updatedAt": "2026-07-11T18:00:00.000000Z"
}

Respuesta · 404 · FOLDER_NOT_FOUND

{
  "type": "https://allsign.io/developers/docs/errors#FOLDER_NOT_FOUND",
  "title": "Folder not found",
  "status": 404,
  "detail": "No folder was found with that id.",
  "instance": "/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c",
  "code": "FOLDER_NOT_FOUND",
  "requestId": "req_8014888fbbde44e0845518524e2aee04"
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts

Update folder

PATCH /folders/{folder_id}

Merge-patch parcial: solo se modifican los campos que envías. Los únicos campos mutables son name y parentId. Enviar cualquier otro campo se rechaza al parsear con 422 VALIDATION_ERROR nombrando el campo ofensor.

Parámetros

folder_id string ruta requerido

ID de la carpeta (fld_…).
AllSign-Version enum header

Fecha del contrato contra la que quieres resolver la petición. Si la omites se sirve la versión vigente; una fecha desconocida responde 400 UNSUPPORTED_API_VERSION.

Valores: 2026-07-11

Cuerpo de la petición

application/json

name string puede ser null

Nuevo nombre de la carpeta.
parentId string puede ser null

Mover bajo otra carpeta (fld_…), o null para llevarla a la raíz.

Devuelve

200 El objeto Folder actualizado. — el objeto Folder

Errores posibles (problem+json): 400 401 403 404 422 429

cURL

curl -X PATCH 'https://api.allsign.io/v3/folders/fld_14bc58afe3634831bf82928332c1ab86' \
  -H "Authorization: Bearer $ALLSIGN_API_KEY" \
  -H "AllSign-Version: 2026-07-11" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "v3audit-ejemplos Contratos firmados"
}'

Node

const respuesta = await fetch('https://api.allsign.io/v3/folders/fld_14bc58afe3634831bf82928332c1ab86', {
    method: 'PATCH',
    headers: {
        Authorization: `Bearer ${process.env.ALLSIGN_API_KEY}`,
        'AllSign-Version': '2026-07-11',
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        name: 'v3audit-ejemplos Contratos firmados',
    }),
});
console.log(respuesta.status, await respuesta.json());

Python

import os

import requests

respuesta = requests.patch(
    "https://api.allsign.io/v3/folders/fld_14bc58afe3634831bf82928332c1ab86",
    headers={
        "Authorization": f"Bearer {os.environ['ALLSIGN_API_KEY']}",
        "AllSign-Version": "2026-07-11",
    },
    json={
        "name": "v3audit-ejemplos Contratos firmados",
    },
)
print(respuesta.status_code, respuesta.json())

Respuesta · 200

{
  "livemode": false,
  "id": "fld_14bc58afe3634831bf82928332c1ab86",
  "object": "folder",
  "name": "v3audit-ejemplos Contratos firmados",
  "ownerId": "usr_beadaffd52b943749b179fded8733b31",
  "parentId": "fld_c1c3fb2ea6634f929addda83f073a00c",
  "hasDocs": false,
  "isMain": false,
  "createdAt": "2026-07-11T18:00:00.441000Z",
  "updatedAt": "2026-07-11T18:00:01.157000Z"
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts

Delete folder

DELETE /folders/{folder_id}

Elimina una carpeta vacía. Si todavía tiene documentos o subcarpetas, la respuesta es 409 FOLDER_NOT_EMPTY (problem+json): vacía o mueve su contenido primero. La carpeta borrada no se recupera.

Parámetros

folder_id string ruta requerido

ID de la carpeta (fld_…).
AllSign-Version enum header

Fecha del contrato contra la que quieres resolver la petición. Si la omites se sirve la versión vigente; una fecha desconocida responde 400 UNSUPPORTED_API_VERSION.

Valores: 2026-07-11

Devuelve

204 Eliminada. Sin body.

Errores posibles (problem+json): 400 401 403 404 409 422 429

cURL

curl -X DELETE 'https://api.allsign.io/v3/folders/fld_14bc58afe3634831bf82928332c1ab86' \
  -H "Authorization: Bearer $ALLSIGN_API_KEY" \
  -H "AllSign-Version: 2026-07-11"

Node

const respuesta = await fetch('https://api.allsign.io/v3/folders/fld_14bc58afe3634831bf82928332c1ab86', {
    method: 'DELETE',
    headers: {
        Authorization: `Bearer ${process.env.ALLSIGN_API_KEY}`,
        'AllSign-Version': '2026-07-11',
    },
});
console.log(respuesta.status);

Python

import os

import requests

respuesta = requests.delete(
    "https://api.allsign.io/v3/folders/fld_14bc58afe3634831bf82928332c1ab86",
    headers={
        "Authorization": f"Bearer {os.environ['ALLSIGN_API_KEY']}",
        "AllSign-Version": "2026-07-11",
    },
)
print(respuesta.status_code)

Respuesta

Respuesta · 204

Sin cuerpo.

Respuesta · 409 · FOLDER_NOT_EMPTY

{
  "type": "https://allsign.io/developers/docs/errors#FOLDER_NOT_EMPTY",
  "title": "Conflict",
  "status": 409,
  "detail": "Folder has documents. Move or delete them before deleting the folder.",
  "instance": "/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c",
  "code": "FOLDER_NOT_EMPTY",
  "requestId": "req_0f54ba0e06d645f9adae72d71abadcc9"
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts

List folder documents

GET /folders/{folder_id}/documents

Lista los documentos contenidos en una carpeta, con paginación por cursor. Devuelve el mismo sobre que List documents.

Parámetros

folder_id string ruta requerido

ID de la carpeta (fld_…).
limit integer query

Resultados por página (1–100, default 20).

default 20 · entre 1 y 100
startingAfter string query

Cursor: documentos después de este id (doc_…).
endingBefore string query

Cursor: documentos antes de este id (doc_…).
AllSign-Version enum header

Fecha del contrato contra la que quieres resolver la petición. Si la omites se sirve la versión vigente; una fecha desconocida responde 400 UNSUPPORTED_API_VERSION.

Valores: 2026-07-11

Devuelve

200 Sobre de paginación por cursor con objetos Document.

Ver los 7 atributos de la respuesta

object string, siempre "list"

Siempre "list".
data array de objetos requerido

Arreglo de objetos Document.
Ver 20 atributos hijos
- data[].livemode boolean requerido
  
  true en entorno live, false en test/dev (marca de agua, sin validez legal).
- data[].id string requerido
  
  ID del documento (doc_…).
- data[].object string, siempre "document"
  
  Siempre "document".
- data[].name string requerido
  
  Nombre visible del documento.
- data[].status enum requerido
  
  Estado del ciclo de vida: draft, collecting_data, awaiting_signatures, correcting, processing, completed, expired, voided, error.
  
  Valores: draft collecting_data awaiting_signatures correcting processing completed expired voided error
- data[].documentType string requerido
  
  Token opaco del tipo de documento.
- data[].signerCount integer requerido
  
  Número total de firmantes.
- data[].signedCount integer requerido
  
  Cuántos firmantes ya firmaron.
- data[].ownerId string requerido
  
  Dueño del documento (usr_…).
- data[].orgId string puede ser null
  
  Organización del documento (org_…).
- data[].folderId string puede ser null
  
  Carpeta que contiene el documento (fld_…). Es null si el documento no está en ninguna carpeta que esta credencial pueda abrir con GET /v3/folders/{id}.
- data[].expiresAt string (fecha-hora ISO 8601) puede ser null
  
  Fecha límite de firma (ISO 8601).
- data[].signingOrder enum
  
  parallel o sequential (firmantes por etapas con routingOrder). Disponible sólo si el orden de firma está habilitado en el entorno; si no, pedir sequential responde 403 SEQUENTIAL_NOT_AVAILABLE y todo documento firma en paralelo.
  
  Valores: parallel sequential
- data[].currentStage integer puede ser null
  
  Etapa activa en un documento sequential mientras espera firmas; null en paralelo o al terminar. Disponible sólo si el orden de firma está habilitado en el entorno; si no, pedir sequential responde 403 SEQUENTIAL_NOT_AVAILABLE y todo documento firma en paralelo.
- data[].expirationReminders array de integer puede ser null
  
  Horas antes del vencimiento en las que se envían recordatorios.
- data[].templateId string puede ser null
  
  Plantilla de la que nació el documento (tmpl_…), o null.
- data[].templateVersionId string puede ser null
  
  Versión de esa plantilla cuyo layout se aplicó (tv_…), o null.
- data[].parentDocumentId string puede ser null
  
  Documento del que este es un anexo (doc_…). null si es un documento raíz. Ver POST /documents/{id}/annexes y GET /documents/{id}/family.
- data[].createdAt string (fecha-hora ISO 8601) requerido
  
  Fecha de creación (ISO 8601).
- data[].updatedAt string (fecha-hora ISO 8601) requerido
  
  Última actualización (ISO 8601).
hasMore boolean requerido

true si hay más resultados después de esta página.
nextCursor string puede ser null

Cursor para la siguiente página (pásalo como startingAfter).
previousCursor string puede ser null

Cursor para la página anterior (pásalo como endingBefore).
limit integer requerido

El límite aplicado a esta página.
totalCount integer puede ser null

Total de coincidencias. Solo se llena cuando pides includeTotal=true.

Errores posibles (problem+json): 400 401 403 404 422 429

cURL

curl 'https://api.allsign.io/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c/documents?limit=5' \
  -H "Authorization: Bearer $ALLSIGN_API_KEY" \
  -H "AllSign-Version: 2026-07-11"

Node

const respuesta = await fetch('https://api.allsign.io/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c/documents?limit=5', {
    headers: {
        Authorization: `Bearer ${process.env.ALLSIGN_API_KEY}`,
        'AllSign-Version': '2026-07-11',
    },
});
console.log(respuesta.status, await respuesta.json());

Python

import os

import requests

respuesta = requests.get(
    "https://api.allsign.io/v3/folders/fld_c1c3fb2ea6634f929addda83f073a00c/documents?limit=5",
    headers={
        "Authorization": f"Bearer {os.environ['ALLSIGN_API_KEY']}",
        "AllSign-Version": "2026-07-11",
    },
)
print(respuesta.status_code, respuesta.json())

Respuesta · 200

{
  "object": "list",
  "data": [
    {
      "livemode": false,
      "id": "doc_ec50be6599c04f82a3d8bba51b5cbb24",
      "object": "document",
      "name": "v3audit-ejemplos documento en carpeta",
      "status": "draft",
      "documentType": "EDITABLE",
      "signerCount": 0,
      "signedCount": 0,
      "ownerId": "usr_beadaffd52b943749b179fded8733b31",
      "orgId": "6332dfb0-7654-42fb-8d21-16dcecdee536",
      "folderId": "fld_c1c3fb2ea6634f929addda83f073a00c",
      "expiresAt": null,
      "signingOrder": "parallel",
      "currentStage": null,
      "expirationReminders": null,
      "templateId": null,
      "templateVersionId": null,
      "parentDocumentId": null,
      "createdAt": "2026-07-11T17:59:58.914000Z",
      "updatedAt": "2026-07-11T18:00:01.675000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null,
  "previousCursor": null,
  "limit": 5,
  "totalCount": null
}

Grabado en el entorno interno de AllSign con una key de sandbox · backend 24c0469 · 8 oct 2026, 06:12 (hora CDMX) · test docs-checks-v3/tests/ejemplos/carpetas.ejemplos.spec.ts