Zum Hauptinhalt springen
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": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  },
  "results": [
    {
      "access": "HIDDEN_INDEXABLE",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "defaultHostingUrl": "<string>",
      "encoding": "<string>",
      "expiresAt": 123,
      "extension": "<string>",
      "fileMd5": "<string>",
      "height": 123,
      "id": "<string>",
      "isUsableInContent": true,
      "name": "<string>",
      "parentFolderId": "<string>",
      "path": "<string>",
      "size": 123,
      "sourceGroup": "<string>",
      "type": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "width": 123
    }
  ]
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Starter
Diese API erfordert einen der folgenden Bereiche:
files
files.ui_hidden.read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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.

​
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.

​
before
string
​
createdAt
string<date-time>

Durchsuchen Sie Dateien nach dem Zeitpunkt der Erstellung.

​
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.

​
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.

​
encoding
string

Durchsuchen Sie Dateien nach einer spezifischen Codierung.

​
expiresAt
string<date-time>

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

​
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.

​
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.

​
extension
string

Durchsuchen Sie Dateien mit der angegebenen Erweiterung.

​
fileMd5
string

Durchsuchen Sie Dateien nach einem bestimmten md5-Hash.

​
height
integer

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

​
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.

​
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.

​
idGte
integer
​
idLte
integer
​
ids
integer[]

Durchsuchen Sie nach einer Liste mit Datei-IDs.

​
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.

​
limit
integer

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

​
name
string

Suchen Sie Dateien mit dem angegebenen Namen.

​
parentFolderIds
integer[]

Durchsuchen Sie Dateien innerhalb der angegebenen „folderId“.

​
path
string

Dateien nach Pfad durchsuchen.

​
properties
string[]

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

​
size
integer

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

​
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.

​
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.

​
sort
string[]

Sortieren Sie Dateien nach einem angegebenen Feld.

​
type
string

Filtern Sie nach dem angegebenen Dateityp.

​
updatedAt
string<date-time>

Durchsuchen Sie Dateien nach dem Zeitpunkt der letzten Aktualisierung.

​
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.

​
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.

​
url
string

Durchsuchen Sie Dateien nach Datei-URL.

​
width
integer

Durchsuchen Sie Dateien nach der Breite des Bilds oder Videos.

​
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.

​
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.

Response

successful operation

Collections of files

​
results
object[]
required
​
paging
object