Obtener Carpeta

GET {{base_url}}/v1/folders/{{token}}

Obtener Carpeta

Este endpoint permite obtener el detalle completo de una carpeta específica a partir de su token.
El token es el identificador interno que se obtiene previamente al crear o listar carpetas.

Donde {{token}} corresponde al identificador interno de la carpeta.

Headers

Para autorizar el acceso a la API es necesario incluir el token de autenticación en el encabezado Authorization, utilizando el esquema Bearer. Además, el encabezado Content-Type debe especificar que el cuerpo de la solicitud (si lo hubiera) se envía en formato JSON.

Headers requeridos

Parámetro	Tipo	Descripción	Límites
`Authorization*`	string	Token de acceso obtenido en el login, con el prefijo 'Bearer'.	Obligatorio
`Content-Type`	string	Especifica el tipo de contenido del cuerpo de la solicitud HTTP. Para las peticiones que incluyen datos JSON	'application/json'

Ejemplo de respuesta

{
  "external_id": "a4f2b1d7-93e0-4c9a-b715-2e91f845c8d3",
  "token": "5c82a1f0-47b3-4e24-9e59-40f6d9f7e8a2",
  "name": "Contrato Horizonte",
  "description": "Acuerdo marco para la prestación de servicios de consultoría tecnológica",
  "document_count": 4,
  "signed_documents_count": 1,
  "in_progress_documents_count": 2,
  "not_started_documents_count": 1,
  "created_at": "2024-09-15T10:43:22.000000Z",
  "updated_at": "2024-10-01T18:12:09.000000Z",
  "deleted": false,
  "children": [],
  "parent": null
}

Campos devueltos

La respuesta del servicio incluye los siguientes campos, que describen el estado y los atributos de la carpeta procesada. Estos datos permiten identificar la carpeta, su jerarquía y el estado de los documentos asociados.

Nombre	Tipo	Descripción
`external_id`	string	Identificador asignado por el cliente. Útil para integradores que gestionan IDs propios.
`token`	string	Identificador interno de la carpeta (token), utilizado para operaciones posteriores.
`name`	string	Nombre de la carpeta.
`description`	string	Descripción de la carpeta.
`document_count`	integer	Cantidad total de documentos.
`signed_documents_count`	integer	Documentos firmados.
`in_progress_documents_count`	integer	Documentos en progreso.
`not_started_documents_count`	integer	Documentos no iniciados.
`created_at`	datetime	Fecha de creación (UTC ISO 8601).
`updated_at`	datetime	Fecha de última modificación (UTC ISO 8601).
`deleted`	boolean	Indica si la carpeta está eliminada lógicamente.
`children`	array	Lista de subcarpetas (si las hubiera).
`parent`	object/null	Carpeta padre (null si es raíz).

Errores posibles

Código	Descripción
401	No autorizado (token inválido o ausente).
404	Carpeta no encontrada (token inválido).
500	Error interno inesperado.