GET
/
files
/
v3
/
files
/
search
Pesquisar arquivos
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
    }
  ]
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • 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[]

Uma lista de propriedades de arquivo a serem retornadas.

​
after
string

Compense os resultados da pesquisa por este valor. A compensação padrão é 0, e o máximo de itens para uma determinada pesquisa é 10.000. Reduza sua pesquisa se você atingir esse limite.

​
before
string
​
limit
integer

Número de itens a serem retornados. O limite padrão é 10, o limite máximo é 100.

​
sort
string[]

Classifique os arquivos por um determinado campo.

​
ids
integer[]

Pesquise por uma lista de IDs de arquivo.

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

Pesquise arquivos pela hora de criação.

​
createdAtLte
string<date-time>

Pesquise arquivos por hora menor ou igual à hora de criação. Pode ser usado com "createdAtGte" para criar um intervalo.

​
createdAtGte
string<date-time>

Pesquise arquivos por hora maior ou igual à hora de criação. Pode ser usado com "createdAtLte" para criar um intervalo.

​
updatedAt
string<date-time>

Pesquise arquivos pela hora da última atualização.

​
updatedAtLte
string<date-time>

Pesquise arquivos por hora menor ou igual à hora da última atualização. Pode ser usado com "updatedAtGte" para criar um intervalo.

​
updatedAtGte
string<date-time>

Pesquise arquivos por hora maior ou igual à hora da última atualização. Pode ser usado com "updatedAtLte" para criar um intervalo.

​
name
string

Pesquise arquivos que contêm o nome especificado.

​
path
string

Pesquise os arquivos pelo caminho.

​
parentFolderIds
integer[]

Pesquise arquivos no "folderId" especificado.

​
size
integer

Pesquise arquivos pelo tamanho exato em bytes.

​
sizeLte
integer

Pesquise arquivos por tamanho menor ou igual ao tamanho do arquivo. Pode ser usado com "sizeGte" para criar um intervalo.

​
sizeGte
integer

Pesquise arquivos por tamanho maior ou igual ao tamanho do arquivo. Pode ser usado com "sizeLte" para criar um intervalo.

​
height
integer

Pesquise arquivos pela altura da imagem ou vídeo.

​
heightLte
integer

Pesquise arquivos por altura menor ou igual à largura da imagem ou vídeo. Pode ser usado com "heightGte" para criar um intervalo.

​
heightGte
integer

Pesquise arquivos por altura maior ou igual à largura da imagem ou vídeo. Pode ser usado com "heightLte" para criar um intervalo.

​
width
integer

Pesquise arquivos pela largura da imagem ou vídeo.

​
widthLte
integer

Pesquise arquivos por largura menor ou igual à largura da imagem ou vídeo. Pode ser usado com "widthGte" para criar um intervalo.

​
widthGte
integer

Pesquise arquivos por largura maior ou igual à largura da imagem ou vídeo. Pode ser usado com "widthLte" para criar um intervalo.

​
encoding
string

Pesquise arquivos pela codificação especificada.

​
type
string

Filtre pelo tipo de arquivo fornecido.

​
extension
string

Pesquise arquivos pela extensão especificada.

​
url
string

Pesquise por URL do arquivo.

​
isUsableInContent
boolean

Se "true", mostra os arquivos que foram marcados para serem usados no conteúdo novo. Se "false", mostra os arquivos que não devem ser usados no conteúdo novo.

​
allowsAnonymousAccess
boolean

Pesquise arquivos por acesso. Se "true", mostra apenas arquivos públicos. Se "false", mostra apenas arquivos privados.

​
fileMd5
string

Pesquise arquivos por um hash md5 específico.

​
expiresAt
string<date-time>

Pesquise arquivos pelo hora exata de expiração. A hora deve estar em milissegundos de época.

​
expiresAtLte
string<date-time>

Pesquise arquivos por hora menor ou igual à hora de expiração. Pode ser usado com "expiresAtGte" para criar um intervalo.

​
expiresAtGte
string<date-time>

Pesquise arquivos por hora maior ou igual à hora de expiração. Pode ser usado com "expiresAtLte" para criar um intervalo.

Response

200
application/json

successful operation

Collections of files