GET /folders - ARGOS Identity

Esta página cubre dos endpoints de lectura de carpetas.

Propósito	Endpoint
Carpetas de un perfil	`GET /v1/profiles/{profileId}/folders`
Una carpeta, con sus ítems	`GET /v1/folders/{folderId}`

Listar carpetas

GET /v1/profiles/{profileId}/folders

Parámetros de consulta

Parámetro	Tipo	Por defecto	Descripción
`search`	`string`		Coincidencia parcial con el nombre de la carpeta
`sort`	`string`	`createdAt`	`name` · `createdAt` · `updatedAt`
`order`	`string`	`desc`	`asc` · `desc`
`cursor`	`string`		El `nextCursor` de la respuesta anterior
`limit`	`number`	10	Elementos por página (máx. 100)

curl "https://client-omni-api.argosidentity.com/v1/profiles/pf_6h4y8s2f0v9n/folders?sort=createdAt&order=asc" \
  -H "x-api-key: your-api-key-here"

Respuesta

{
  "count": 2,
  "nextCursor": null,
  "items": [
    {
      "id": "fd_9pq2mklt83bx",
      "profileId": "pf_6h4y8s2f0v9n",
      "name": "default",
      "isDefault": true,
      "itemsCount": 3,
      "createdAt": "2026-09-10T05:32:47.118Z",
      "updatedAt": "2026-09-10T05:35:41.330Z"
    },
    {
      "id": "fd_5t9j1r4b7m2q",
      "profileId": "pf_6h4y8s2f0v9n",
      "name": "Supporting documents",
      "isDefault": false,
      "itemsCount": 0,
      "createdAt": "2026-09-10T06:00:12.004Z",
      "updatedAt": "2026-09-10T06:00:12.004Z"
    }
  ]
}

Campo	Tipo	Descripción
`count`	`number`	Número de elementos en esta respuesta
`nextCursor`	`string \| null`	Cursor de la página siguiente. `null` en la última página
`items[].id`	`string`	ID de la carpeta (prefijo `fd_`)
`items[].profileId`	`string`	ID del perfil padre
`items[].name`	`string`	Nombre de la carpeta
`items[].isDefault`	`boolean`	Si es la carpeta por defecto creada con el perfil
`items[].itemsCount`	`number`	Número de ítems de la carpeta
`items[].createdAt`	`string`	Fecha de creación
`items[].updatedAt`	`string`	Fecha de última modificación

Las reglas de paginación están en la descripción general de la API.

Leer una carpeta

GET /v1/folders/{folderId}

Los mismos campos que una entrada de lista, más un array items.

curl "https://client-omni-api.argosidentity.com/v1/folders/fd_9pq2mklt83bx" \
  -H "x-api-key: your-api-key-here"

Respuesta

{
  "id": "fd_9pq2mklt83bx",
  "profileId": "pf_6h4y8s2f0v9n",
  "name": "default",
  "isDefault": true,
  "itemsCount": 3,
  "items": [
    {
      "id": "item_axfkh2noof85",
      "type": "text",
      "name": "certificate of good standing",
      "contentType": "text/plain",
      "sizeBytes": 538,
      "createdAt": "2026-09-10T05:35:31.412Z"
    }
  ],
  "createdAt": "2026-09-10T05:32:47.118Z",
  "updatedAt": "2026-09-10T05:35:41.330Z"
}

Campo	Tipo	Descripción
`items[].id`	`string`	ID del ítem (prefijo `item_`)
`items[].type`	`string`	`file` · `text` · `json`
`items[].name`	`string`	Nombre del ítem
`items[].contentType`	`string \| null`	Tipo MIME
`items[].sizeBytes`	`number \| null`	Tamaño en bytes
`items[].createdAt`	`string`	Fecha de creación

Cuando necesite además el cuerpo y el estado de procesamiento, use leer ítems.

Códigos de error

Estado	Código	Descripción
404	`OMNI_3005`	Perfil no encontrado (lista)
404	`OMNI_3009`	Carpeta no encontrada (carpeta concreta)

Los errores comunes (400 validación · 401 autenticación · 403 permisos · 500 servidor) están en la descripción general de la API.

⌘I