GET
/
files
/
v3
/
files
/
search
Buscar archivos
curl --request GET \
  --url https://api.hubapi.com/files/v3/files/search \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "extension": "<string>",
      "access": "PUBLIC_INDEXABLE",
      "parentFolderId": "<string>",
      "sourceGroup": "<string>",
      "fileMd5": "<string>",
      "encoding": "<string>",
      "type": "<string>",
      "isUsableInContent": true,
      "url": "<string>",
      "expiresAt": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "path": "<string>",
      "archived": true,
      "size": 123,
      "name": "<string>",
      "width": 123,
      "id": "<string>",
      "defaultHostingUrl": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "height": 123
    }
  ]
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubStarter

​
Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • files.ui_hidden.read
  • files

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
properties
string[]

Una lista de propiedades de archivo a devolver.

​
after
string

Desplaza los resultados de la búsqueda en este valor. El desplazamiento predeterminado es 0 y el desplazamiento máximo de elementos para una búsqueda determinada es de 10.000. Reduce la búsqueda si llegas a este límite.

​
before
string
​
limit
integer

Número de elementos que se devolverán. El límite predeterminado es 10, el límite máximo es 100.

​
sort
string[]

Ordenar archivos por un campo dado.

​
ids
integer[]

Buscar por una lista de ID de archivos.

​
idLte
integer
​
idGte
integer
​
createdAt
string<date-time>

Buscar archivos por fecha de creación.

​
createdAtLte
string<date-time>

Buscar archivos por menos o igual a la hora de creación. Se puede utilizar con createdAtGte para crear un rango.

​
createdAtGte
string<date-time>

Buscar archivos por mayor o igual a la hora de creación. Se puede utilizar con createdAtLte para crear un rango.

​
updatedAt
string<date-time>

Buscar archivos por hora de la última actualización.

​
updatedAtLte
string<date-time>

Buscar archivos por menos o igual a la hora de última actualización. Se puede utilizar con updatedAtGte para crear un rango.

​
updatedAtGte
string<date-time>

Buscar archivos por mayor o igual a la hora de última actualización. Se puede utilizar con updatedAtLte para crear un rango.

​
name
string

Buscar archivos que contengan el nombre dado.

​
path
string

Buscar archivos por ruta.

​
parentFolderIds
integer[]

Buscar archivos dentro del folderId dado.

​
size
integer

Buscar archivos por su tamaño exacto en bytes.

​
sizeLte
integer

Buscar archivos por menos o igual al tamaño del archivo. Se puede utilizar con sizeGte para crear un rango.

​
sizeGte
integer

Buscar archivos por mayor o igual al tamaño del archivo. Se puede utilizar con sizeLte para crear un rango.

​
height
integer

Buscar archivos por altura de imagen o vídeo.

​
heightLte
integer

Buscar archivos por menos o igual que la altura de la imagen o el video. Se puede utilizar con heightGte para crear un rango.

​
heightGte
integer

Buscar archivos por mayor o igual que la altura de la imagen o el video. Se puede utilizar con heightLte para crear un rango.

​
width
integer

Buscar archivos por ancho de imagen o video.

​
widthLte
integer

Buscar archivos por menos o igual que el ancho de la imagen o el video. Se puede utilizar con widthGte para crear un rango.

​
widthGte
integer

Buscar archivos por mayor o igual que el ancho de la imagen o el video. Se puede utilizar con widthLte para crear un rango.

​
encoding
string

Buscar archivos por la codificación especificada.

​
type
string

Filtrar por tipo de archivo proporcionado.

​
extension
string

Buscar archivos por la extensión proporcionada.

​
url
string

Buscar por URL de archivo.

​
isUsableInContent
boolean

Si es true, muestra los archivos marcados para ser utilizados en nuevos contenidos. Si es false, muestra los archivos que no deben utilizarse en nuevos contenidos.

​
allowsAnonymousAccess
boolean

Buscar archivos por acceso. Si es true, solo mostrará archivos públicos. Si es false, solo mostrará los archivos privados.

​
fileMd5
string

Buscar archivos por un hash md5 específico.

​
expiresAt
string<date-time>

Buscar archivos por hora exacta de vencimiento. La hora debe ser la hora en milisegundos de Epoch.

​
expiresAtLte
string<date-time>

Buscar archivos por menos o igual a la hora de vencimiento. Se puede utilizar con expiresAtGte para crear un rango.

​
expiresAtGte
string<date-time>

Buscar archivos por mayor o igual a la hora de vencimiento. Se puede utilizar con expiresAtLte para crear un rango.

Response

200
application/json

successful operation

Collections of files