Ir al contenido
Sursa Developers

GET/v1/folders

Obtener los árboles de carpetas de todas las colecciones

folder_trees

Devuelve, en una sola respuesta, los árboles de carpetas de todas las colecciones en las que el usuario puede ver al menos un objeto, con las mismas reglas de visibilidad que GET /v1/collections/{name}/folders y en el orden de GET /v1/collections. Una colección sin objetos visibles queda fuera. Además de cards, cada carpeta tiene los totales del subárbol cards_total, sensitive_total y top_category. Con updated_since o metadata[<key>]=, folders de cada colección contiene las carpetas que coinciden como una lista plana (children está vacío, y parent_id indica el lugar en el árbol). Con updated_since, se ordenan por updated_at ascendente y después por id; sin él, en el orden de sort_key. Las colecciones sin carpetas que coincidan quedan fuera.

Autenticación

Envíe una clave de API en el encabezado Authorization: Authorization: Bearer <clave>.

Parámetros de consulta

  • limitinteger

    Tamaño de página. Sin limit ni cursor se devuelve la lista completa; con él, como máximo limit elementos, y la página siguiente se indica en los encabezados Link (rel="next") y X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Cursor de la página siguiente, tomado de X-Next-Cursor o de next_cursor de la respuesta anterior con los mismos filtros; incluye el tamaño de página. Junto con offset: 422 validation.failed; un cursor de otra lista, de otros filtros o mal formado: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Solo los objetos con updated_at igual o posterior a este momento (RFC 3339 con desfase horario), para la sincronización. Con él, la lista se ordena por updated_at ascendente y después por id, y el cursor continúa en ese orden. Los objetos eliminados no aparecen en la lista: las eliminaciones llegan como eventos.

    length ≤ 512

  • metadatamap of string

    Filtro por metadata: metadata[<key>]=<value> busca una coincidencia exacta. Hasta 3 condiciones, y deben cumplirse todas (?metadata[team]=support&metadata[crm_id]=A-1042). Más de 3 condiciones o una clave no válida devuelven 400 api.metadata_invalid.

Respuestas

200Respuesta correcta

Encabezados de la respuesta

  • Link

    Dirección de la página siguiente, <…>; rel="next". Si no hay encabezado, es la última página.

  • X-Next-Cursor

    Cursor de la página siguiente para el parámetro cursor. Si no hay encabezado, es la última página.

  • RateLimit-Policy

    Límites vigentes, en el formato del borrador del IETF draft-ietf-httpapi-ratelimit-headers: elementos separados por comas "<name>";q=<quota>;w=<window in seconds>. key es la frecuencia de solicitudes de la clave de API (la cuota es la ráfaga y la ventana es el tiempo que tarda en recargarse por completo; para una sesión es user y sin credenciales, ip); minute, day y month son las cuotas de la organización para el minuto, el día y el mes naturales en UTC.

  • RateLimit

    Lo que queda de cada límite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Límite de la entrada más estricta de RateLimit-Policy (la que tiene menos solicitudes restantes).

  • X-RateLimit-Remaining

    Solicitudes restantes del límite más estricto.

  • X-RateLimit-Reset

    Segundos hasta que se restablece el límite más estricto.

application/json

Objeto: FolderTreeList

array of FolderTree
  • collection_idintegerobligatorio
  • collection_namestringobligatorio
  • collection_titlestringobligatorio

    Nombre de la colección que se muestra.

  • permissionsarray of stringobligatorio

    Los permisos efectivos del usuario sobre la colección.

  • unfiledintegerobligatorio

    Tarjetas de la colección disponibles para el usuario que no están en ninguna carpeta. Las tarjetas archivadas no se cuentan, como en la lista de tarjetas predeterminada.

  • foldersarray of FolderNodeobligatorio
401No se enviaron credenciales (ni una cookie de sesión ni una clave de API) o no se encontró la clave.

Encabezados de la respuesta

  • RateLimit-Policy

    Límites vigentes, en el formato del borrador del IETF draft-ietf-httpapi-ratelimit-headers: elementos separados por comas "<name>";q=<quota>;w=<window in seconds>. key es la frecuencia de solicitudes de la clave de API (la cuota es la ráfaga y la ventana es el tiempo que tarda en recargarse por completo; para una sesión es user y sin credenciales, ip); minute, day y month son las cuotas de la organización para el minuto, el día y el mes naturales en UTC.

  • RateLimit

    Lo que queda de cada límite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Límite de la entrada más estricta de RateLimit-Policy (la que tiene menos solicitudes restantes).

  • X-RateLimit-Remaining

    Solicitudes restantes del límite más estricto.

  • X-RateLimit-Reset

    Segundos hasta que se restablece el límite más estricto.

application/json

Objeto: Error

429Demasiadas solicitudes (`api.rate_limited`), se agotó la cuota de la organización para el minuto, el día o el mes (`api.quota_exceeded`; `error.details` contiene `quota`, `limit` y `reset_at`), se alcanzó el límite de la organización o el servicio de respuestas está ocupado (`answers.engine_busy`). Espere el tiempo indicado en el encabezado `Retry-After`.

Encabezados de la respuesta

  • Retry-After

    Número de segundos que hay que esperar antes de reintentar la solicitud.

  • RateLimit-Policy

    Límites vigentes, en el formato del borrador del IETF draft-ietf-httpapi-ratelimit-headers: elementos separados por comas "<name>";q=<quota>;w=<window in seconds>. key es la frecuencia de solicitudes de la clave de API (la cuota es la ráfaga y la ventana es el tiempo que tarda en recargarse por completo; para una sesión es user y sin credenciales, ip); minute, day y month son las cuotas de la organización para el minuto, el día y el mes naturales en UTC.

  • RateLimit

    Lo que queda de cada límite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Límite de la entrada más estricta de RateLimit-Policy (la que tiene menos solicitudes restantes).

  • X-RateLimit-Remaining

    Solicitudes restantes del límite más estricto.

  • X-RateLimit-Reset

    Segundos hasta que se restablece el límite más estricto.

application/json

Objeto: Error

Códigos de error

Códigos que este endpoint puede devolver en error.code, además de los códigos generales de cualquier solicitud.

Límites de frecuencia

Las respuestas incluyen los encabezados RateLimit y RateLimit-Policy y los anteriores X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Una respuesta 429 lleva Retry-After en segundos: espere y vuelva a intentarlo.

← folders · Referencia de la API