Pular para o conteúdo principal
POST
/
crm
/
v3
/
exports
/
export
/
async
Comece uma exportação
curl --request POST \
  --url https://api.hubapi.com/crm/v3/exports/export/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exportType": "VIEW",
  "format": "XLS",
  "exportName": "<string>",
  "objectProperties": [
    "<string>"
  ],
  "associatedObjectType": [
    "<string>"
  ],
  "includeLabeledAssociations": true,
  "includePrimaryDisplayPropertyForAssociatedObjects": true,
  "objectType": "<string>",
  "language": "EN",
  "exportInternalValuesOptions": [
    "NAMES"
  ],
  "overrideAssociatedObjectsPerDefinitionPerRowLimit": true,
  "publicCrmSearchRequest": {
    "filterGroups": [
      {
        "filters": [
          {
            "operator": "BETWEEN",
            "propertyName": "<string>",
            "highValue": "<string>",
            "value": "<string>",
            "values": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "filters": [
      {
        "operator": "BETWEEN",
        "propertyName": "<string>",
        "highValue": "<string>",
        "value": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "sorts": [
      "<string>"
    ],
    "query": "<string>"
  }
}
'
{
  "id": "<string>",
  "links": {}
}

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

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
exportType
enum<string>
padrão:VIEW
obrigatório
Opções disponíveis:
VIEW
format
enum<string>
obrigatório
Opções disponíveis:
XLS,
XLSX,
CSV
exportName
string
obrigatório
objectProperties
string[]
obrigatório
associatedObjectType
string[]
obrigatório
includeLabeledAssociations
boolean
obrigatório
includePrimaryDisplayPropertyForAssociatedObjects
boolean
obrigatório
objectType
string
obrigatório
language
enum<string>
obrigatório
Opções disponíveis:
EN,
DE,
ES,
FR,
JA,
NL,
PT_BR,
IT,
PL,
SV,
FI,
ZH_TW,
DA_DK,
NO,
KO_KR,
TH,
ZH_CN
exportInternalValuesOptions
enum<string>[]
obrigatório
Opções disponíveis:
NAMES,
VALUES
overrideAssociatedObjectsPerDefinitionPerRowLimit
boolean
obrigatório
publicCrmSearchRequest
object

Resposta

accepted

id
string
obrigatório

O ID exclusivo da exportação.

Um objeto contendo links relevantes relacionados ao processo de exportação.

Last modified on March 24, 2026