Pular para o conteúdo principal
GET
/
files
/
v3
/
files
/
search
Pesquisar arquivos
curl --request GET \
  --url https://api.hubapi.com/files/v3/files/search \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "access": "HIDDEN_INDEXABLE",
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "defaultHostingUrl": "<string>",
      "encoding": "<string>",
      "expiresAt": 123,
      "extension": "<string>",
      "fileMd5": "<string>",
      "height": 123,
      "isUsableInContent": true,
      "name": "<string>",
      "parentFolderId": "<string>",
      "path": "<string>",
      "size": 123,
      "sourceGroup": "CONTENT",
      "type": "<string>",
      "url": "<string>",
      "width": 123
    }
  ],
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis
Esta API requer um dos seguintes escopos:
files
files.ui_hidden.read

Autorizações

​
Authorization
string
header
obrigatório

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

Parâmetros de consulta

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

​
allowsAnonymousAccess
boolean

Pesquise os arquivos por acesso. Se "true", mostrará apenas arquivos públicos; se "false", mostrará apenas arquivos privados

​
before
string

Pesquise os arquivos atualizados antes desta data/hora. A hora deve estar em milissegundos de época.

​
createdAt
string<date-time>

Pesquise os arquivos pela hora exata de criação. A hora deve estar em milissegundos de época.

​
createdAtGte
string<date-time>

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

​
createdAtLte
string<date-time>

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

​
encoding
string

Pesquise arquivos pela codificação especificada.

​
expiresAt
string<date-time>

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

​
expiresAtGte
string<date-time>

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

​
expiresAtLte
string<date-time>

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

​
extension
string

Pesquise arquivos pela extensão especificada.

​
fileMd5
string

Pesquise os arquivos por um hash md5 específico.

​
height
integer<int32>

Pesquise arquivos pela altura da imagem ou vídeo.

​
heightGte
integer<int32>

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

​
heightLte
integer<int32>

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

​
idGte
integer<int64>

Pesquise os arquivos por ID maior ou igual. Pode ser usado com idLte para criar um intervalo.

​
idLte
integer<int64>

Pesquise os arquivos por ID menor ou igual. Pode ser usado com idGte para criar um intervalo.

​
ids
integer<int64>[]

Pesquise por uma lista de IDs de arquivo.

​
isUsableInContent
boolean

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

​
limit
integer<int32>

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

​
name
string

Pesquise arquivos que contêm o nome especificado.

​
parentFolderIds
integer<int64>[]

Pesquise arquivos no "folderId" especificado.

​
path
string

Pesquise os arquivos pelo caminho.

​
properties
string[]

Propriedades do arquivo desejadas no objeto de retorno.

​
size
integer<int64>

Pesquise arquivos pelo tamanho exato em bytes.

​
sizeGte
integer<int64>

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

​
sizeLte
integer<int64>

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

​
sort
string[]

Classifique os arquivos por um determinado campo.

​
type
string

Pesquise arquivos por tipo de arquivo.

​
updatedAt
string<date-time>

Pesquise os arquivos pela hora exata da última atualização. A hora deve estar em milissegundos de época.

​
updatedAtGte
string<date-time>

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

​
updatedAtLte
string<date-time>

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

​
url
string

Pesquise o URL especificado

​
width
integer<int32>

Pesquise arquivos pela largura da imagem ou vídeo.

​
widthGte
integer<int32>

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

​
widthLte
integer<int32>

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

Resposta

successful operation

Collections of files

​
results
object[]
obrigatório
​
paging
object
Last modified on March 24, 2026