GET
/
files
/
v3
/
files
/
search
Rechercher les fichiers
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
    }
  ]
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • 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[]

Une liste de propriétés de fichiers à renvoyer.

​
after
string

Décaler les résultats de la recherche de cette valeur. Le décalage par défaut est de 0 et le décalage maximal des éléments pour une recherche donnée est de 10 000. Limitez votre recherche si vous atteignez cette limite.

​
before
string
​
limit
integer

Nombre d'éléments à renvoyer. La limite par défaut est de 10, la limite maximale est de 100.

​
sort
string[]

Trier les fichiers selon un champ donné.

​
ids
integer[]

Recherche par liste d'ID de fichier.

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

Rechercher des fichiers par heure de création.

​
createdAtLte
string<date-time>

Recherche de fichiers par date de création inférieure ou égale. Peut être utilisé avec createdAtGte pour créer une plage.

​
createdAtGte
string<date-time>

Recherche de fichiers par date de création supérieure ou égale. Peut être utilisé avec createdAtLte pour créer une plage.

​
updatedAt
string<date-time>

Rechercher des fichiers par heure de dernière mise à jour.

​
updatedAtLte
string<date-time>

Recherche de fichiers par heure de dernière mise à jour inférieure ou égale. Peut être utilisé avec updatedGtLte pour créer une plage.

​
updatedAtGte
string<date-time>

Recherche de fichiers par heure de dernière mise à jour supérieure ou égale. Peut être utilisé avec updatedAtLte pour créer une plage.

​
name
string

Rechercher des fichiers contenant le nom donné.

​
path
string

Rechercher des fichiers par chemin

​
parentFolderIds
integer[]

Rechercher des fichiers avec le folderId spécifié.

​
size
integer

Rechercher des fichiers par leur taille exacte en octets.

​
sizeLte
integer

Recherche de fichiers par taille inférieure ou égale. Peut être utilisé avec sizeGte pour créer une plage.

​
sizeGte
integer

Recherche de fichiers par taille de fichier supérieure ou égale. Peut être utilisé avec sizeLte pour créer une plage.

​
height
integer

Rechercher des fichiers par hauteur d'image ou de vidéo.

​
heightLte
integer

Recherche de fichiers par taille d'image ou de vidéo inférieure ou égale. Peut être utilisé avec heightGte pour créer une plage.

​
heightGte
integer

Recherche de fichiers par taille d'image ou de vidéo supérieure ou égale. Peut être utilisé avec heightLte pour créer une plage.

​
width
integer

Rechercher des fichiers par largeur d'image ou de vidéo.

​
widthLte
integer

Recherche de fichiers par largeur d'image ou de vidéo inférieure ou égale. Peut être utilisé avec widthGte pour créer une plage.

​
widthGte
integer

Recherche de fichiers par largeur d'image ou de vidéo supérieure ou égale. Peut être utilisé avec widthLte pour créer une plage.

​
encoding
string

Rechercher des fichiers par encodage spécifié.

​
type
string

Filtrer par type de fichier fourni.

​
extension
string

Rechercher des fichiers par extension donnée.

​
url
string

Rechercher par URL de fichier.

​
isUsableInContent
boolean

Si true, les fichiers marqués pour utilisation dans un nouveau contenu seront affichés. Si false, les fichiers à ne pas utiliser dans un nouveau contenu seront affichés.

​
allowsAnonymousAccess
boolean

Recherche de fichiers par accès. Si true, seuls les fichiers publics seront affichés. Si false, seuls les fichiers privés seront affichés.

​
fileMd5
string

Recherche de fichiers à partir d'un hachage md5 spécifique.

​
expiresAt
string<date-time>

Recherche de fichiers en fonction de l'heure exacte d'expiration. L'heure doit être l'heure d'origine en millisecondes.

​
expiresAtLte
string<date-time>

Recherche de fichiers par heure d'expiration inférieure ou égale. Peut être utilisé avec expiresAtGte pour créer une plage.

​
expiresAtGte
string<date-time>

Recherche de fichiers par heure d'expiration supérieure ou égale. Peut être utilisé avec expiresAtLte pour créer une plage.

Response

200
application/json

successful operation

Collections of files