Get Folder

GET

https://app.firmeasy.legal/api/v1/folders/{{token}}

Get Folder

This endpoint allows you to get the full details of a specific folder using its token.
The token is the internal identifier previously obtained when creating or listing folders.

Where {token} corresponds to the folder’s internal identifier.

Headers

To authorize access to the API, you must include the authentication token in the Authorization header using the Bearer scheme. Additionally, the Content-Type header must specify that the request body (if any) is sent in JSON format.

Headers requeridos

Parameter	Type	Description	Limits
`Authorization`	string	Access token obtained during login, with the 'Bearer' prefix.	Required
`Content-Type`	string	Specifies the content type of the HTTP request body. For requests that include JSON data	'application/json'

Authorization

string

Access token obtained during login, with the 'Bearer' prefix.

Limits:Required

Content-Type

string

Specifies the content type of the HTTP request body. For requests that include JSON data

Limits:'application/json'

Response Example

{
  "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
}

Returned Fields

The service response includes the following fields, which describe the status and attributes of the processed folder. This data allows you to identify the folder, its hierarchy, and the status of associated documents.

Nombre	Type	Description
`external_id`	string	Identifier assigned by the client. Useful for integrators who manage their own IDs.
`token`	string	Internal folder identifier (token), used for subsequent operations.
`name`	string	Folder name.
`description`	string	Folder description.
`document_count`	integer	Total number of documents.
`signed_documents_count`	integer	Signed documents.
`in_progress_documents_count`	integer	Documents in progress.
`not_started_documents_count`	integer	Documents not started.
`created_at`	datetime	Creation date (UTC ISO 8601).
`updated_at`	datetime	Last modification date (UTC ISO 8601).
`deleted`	boolean	Indicates if the folder is logically deleted.
`children`	array	List of subfolders (if any).
`parent`	object/null	Parent folder (null if root).

external_id

string

Identifier assigned by the client. Useful for integrators who manage their own IDs.

token

string

Internal folder identifier (token), used for subsequent operations.

name

string

Folder name.

description

string

Folder description.

document_count

integer

Total number of documents.

signed_documents_count

integer

Signed documents.

in_progress_documents_count

integer

Documents in progress.

not_started_documents_count

integer

Documents not started.

created_at

datetime

Creation date (UTC ISO 8601).

updated_at

datetime

Last modification date (UTC ISO 8601).

deleted

boolean

Indicates if the folder is logically deleted.

children

array

List of subfolders (if any).

parent

object/null

Parent folder (null if root).

Possible Errors

Code	Description
401	Unauthorized (invalid or missing token).
404	Folder not found (invalid token).
500	Unexpected internal error.