GET
/
files
/
v3
/
files
/
search
Dateien durchsuchen
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
    }
  ]
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubKostenlos
Sales HubSales HubKostenlos
Service HubService HubKostenlos
Content HubContent HubStarter

​
Erforderliche Bereiche

Diese API erfordert einen der folgenden Bereiche:
  • 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[]

Eine Liste mit Dateieigenschaften, die zurückgegeben werden sollen.

​
after
string

Suchergebnisse nach diesem Wert versetzen. Der Standardversatz beträgt 0 und der maximale Versatz von Elementen für eine bestimmte Suche beträgt 10.000. Verfeinern Sie Ihre Suche, wenn Sie diese Grenze erreichen.

​
before
string
​
limit
integer

Anzahl der Elemente, die zurückgegeben werden sollen. Standardlimit: 10; maximales Limit: 100.

​
sort
string[]

Sortieren Sie Dateien nach einem angegebenen Feld.

​
ids
integer[]

Durchsuchen Sie nach einer Liste mit Datei-IDs.

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

Durchsuchen Sie Dateien nach dem Zeitpunkt der Erstellung.

​
createdAtLte
string<date-time>

Durchsuchen Sie Dateien nach dem „ist kleiner als“- oder „ist gleich“-Zeitpunkt der Erstellung. Kann mit „createdAtGte“ verwendet werden, um einen Bereich zu erstellen.

​
createdAtGte
string<date-time>

Durchsuchen Sie Dateien nach dem „ist größer als“- oder „ist gleich“-Zeitpunkt der Erstellung. Kann mit „createdAtLte“ verwendet werden, um einen Bereich zu erstellen.

​
updatedAt
string<date-time>

Durchsuchen Sie Dateien nach dem Zeitpunkt der letzten Aktualisierung.

​
updatedAtLte
string<date-time>

Durchsuchen Sie Dateien nach dem „ist kleiner als“- oder „ist gleich“-Zeitpunkt der letzten Aktualisierung. Kann mit „updatedAtGte“ verwendet werden, um einen Bereich zu erstellen.

​
updatedAtGte
string<date-time>

Durchsuchen Sie Dateien nach dem „ist größer als“- oder „ist gleich“-Zeitpunkt der letzten Aktualisierung. Kann mit „updatedAtLte“ verwendet werden, um einen Bereich zu erstellen.

​
name
string

Suchen Sie Dateien mit dem angegebenen Namen.

​
path
string

Dateien nach Pfad durchsuchen.

​
parentFolderIds
integer[]

Durchsuchen Sie Dateien innerhalb der angegebenen „folderId“.

​
size
integer

Durchsuchen Sie Dateien nach der tatsächlichen Dateigröße in Bytes.

​
sizeLte
integer

Durchsuchen Sie Dateien nach der „ist kleiner als“- oder „ist gleich“-Dateigröße. Kann mit „sizeGte“ verwendet werden, um einen Bereich zu erstellen.

​
sizeGte
integer

Durchsuchen Sie Dateien nach der „ist größer als“- oder „ist gleich“-Dateigröße. Kann mit „sizeLte“ verwendet werden, um einen Bereich zu erstellen.

​
height
integer

Durchsuchen Sie Dateien nach der Höhe des Bilds oder Videos.

​
heightLte
integer

Durchsuchen Sie Dateien nach der „ist kleiner als“- oder „ist gleich“-Höhe des Bilds oder Videos. Kann mit „heightGte“ verwendet werden, um einen Bereich zu erstellen.

​
heightGte
integer

Durchsuchen Sie Dateien nach der „ist größer als“- oder „ist gleich“-Höhe des Bilds oder Videos. Kann mit „heightLte“ verwendet werden, um einen Bereich zu erstellen.

​
width
integer

Durchsuchen Sie Dateien nach der Breite des Bilds oder Videos.

​
widthLte
integer

Durchsuchen Sie Dateien nach der „ist kleiner als“- oder „ist gleich“-Breite des Bilds oder Videos. Kann mit „widthGte“ verwendet werden, um einen Bereich zu erstellen.

​
widthGte
integer

Durchsuchen Sie Dateien nach der „ist größer als“- oder „ist gleich“-Breite des Bilds oder Videos. Kann mit „widthLte“ verwendet werden, um einen Bereich zu erstellen.

​
encoding
string

Durchsuchen Sie Dateien nach einer spezifischen Codierung.

​
type
string

Filtern Sie nach dem angegebenen Dateityp.

​
extension
string

Durchsuchen Sie Dateien mit der angegebenen Erweiterung.

​
url
string

Durchsuchen Sie Dateien nach Datei-URL.

​
isUsableInContent
boolean

Wenn bei „true“ (wahr) Dateien angezeigt werden, die für die Verwendung in neuem Content markiert wurden. Bei „false“ (falsch) werden Dateien angezeigt, die in neuem Content nicht verwendet werden sollten.

​
allowsAnonymousAccess
boolean

Durchsuchen Sie Dateien nach Zugriff. „true“ (wahr) verweist darauf, dass nur öffentliche Dateien angezeigt werden. Bei „false“ (falsch) werden nur private Dateien angezeigt.

​
fileMd5
string

Durchsuchen Sie Dateien nach einem bestimmten md5-Hash.

​
expiresAt
string<date-time>

Durchsuchen Sie Dateien nach der tatsächlichen Ablaufzeit. Angaben der Zeit in Epochen-Millisekunden erforderlich.

​
expiresAtLte
string<date-time>

Durchsuchen Sie Dateien nach der „ist kleiner als“- oder „ist gleich“-Ablaufzeit. Kann mit „expiresAtGte“ verwendet werden, um einen Bereich zu erstellen.

​
expiresAtGte
string<date-time>

Durchsuchen Sie Dateien nach der „ist größer als“- oder „ist gleich“-Ablaufzeit. Kann mit „expiresAtLte“ verwendet werden, um einen Bereich zu erstellen.

Response

200
application/json

successful operation

Collections of files