エクスポートを開始
curl --request POST \
--url https://api.hubapi.com/crm/v3/exports/export/async \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"associatedObjectType": [
"<string>"
],
"exportInternalValuesOptions": [],
"exportName": "<string>",
"exportType": "VIEW",
"includeLabeledAssociations": true,
"includePrimaryDisplayPropertyForAssociatedObjects": true,
"objectProperties": [
"<string>"
],
"objectType": "<string>",
"overrideAssociatedObjectsPerDefinitionPerRowLimit": true
}
'import requests
url = "https://api.hubapi.com/crm/v3/exports/export/async"
payload = {
"associatedObjectType": ["<string>"],
"exportInternalValuesOptions": [],
"exportName": "<string>",
"exportType": "VIEW",
"includeLabeledAssociations": True,
"includePrimaryDisplayPropertyForAssociatedObjects": True,
"objectProperties": ["<string>"],
"objectType": "<string>",
"overrideAssociatedObjectsPerDefinitionPerRowLimit": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
associatedObjectType: ['<string>'],
exportInternalValuesOptions: [],
exportName: '<string>',
exportType: 'VIEW',
includeLabeledAssociations: true,
includePrimaryDisplayPropertyForAssociatedObjects: true,
objectProperties: ['<string>'],
objectType: '<string>',
overrideAssociatedObjectsPerDefinitionPerRowLimit: true
})
};
fetch('https://api.hubapi.com/crm/v3/exports/export/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/crm/v3/exports/export/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'associatedObjectType' => [
'<string>'
],
'exportInternalValuesOptions' => [
],
'exportName' => '<string>',
'exportType' => 'VIEW',
'includeLabeledAssociations' => true,
'includePrimaryDisplayPropertyForAssociatedObjects' => true,
'objectProperties' => [
'<string>'
],
'objectType' => '<string>',
'overrideAssociatedObjectsPerDefinitionPerRowLimit' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/crm/v3/exports/export/async"
payload := strings.NewReader("{\n \"associatedObjectType\": [\n \"<string>\"\n ],\n \"exportInternalValuesOptions\": [],\n \"exportName\": \"<string>\",\n \"exportType\": \"VIEW\",\n \"includeLabeledAssociations\": true,\n \"includePrimaryDisplayPropertyForAssociatedObjects\": true,\n \"objectProperties\": [\n \"<string>\"\n ],\n \"objectType\": \"<string>\",\n \"overrideAssociatedObjectsPerDefinitionPerRowLimit\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/v3/exports/export/async")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"associatedObjectType\": [\n \"<string>\"\n ],\n \"exportInternalValuesOptions\": [],\n \"exportName\": \"<string>\",\n \"exportType\": \"VIEW\",\n \"includeLabeledAssociations\": true,\n \"includePrimaryDisplayPropertyForAssociatedObjects\": true,\n \"objectProperties\": [\n \"<string>\"\n ],\n \"objectType\": \"<string>\",\n \"overrideAssociatedObjectsPerDefinitionPerRowLimit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/crm/v3/exports/export/async")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"associatedObjectType\": [\n \"<string>\"\n ],\n \"exportInternalValuesOptions\": [],\n \"exportName\": \"<string>\",\n \"exportType\": \"VIEW\",\n \"includeLabeledAssociations\": true,\n \"includePrimaryDisplayPropertyForAssociatedObjects\": true,\n \"objectProperties\": [\n \"<string>\"\n ],\n \"objectType\": \"<string>\",\n \"overrideAssociatedObjectsPerDefinitionPerRowLimit\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"links": {}
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}エクスポート
Start an export
リクエスト本文で指定されているようにポータルでCRMデータのエクスポートが開始されます
POST
/
crm
/
v3
/
exports
/
export
/
async
エクスポートを開始
curl --request POST \
--url https://api.hubapi.com/crm/v3/exports/export/async \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"associatedObjectType": [
"<string>"
],
"exportInternalValuesOptions": [],
"exportName": "<string>",
"exportType": "VIEW",
"includeLabeledAssociations": true,
"includePrimaryDisplayPropertyForAssociatedObjects": true,
"objectProperties": [
"<string>"
],
"objectType": "<string>",
"overrideAssociatedObjectsPerDefinitionPerRowLimit": true
}
'import requests
url = "https://api.hubapi.com/crm/v3/exports/export/async"
payload = {
"associatedObjectType": ["<string>"],
"exportInternalValuesOptions": [],
"exportName": "<string>",
"exportType": "VIEW",
"includeLabeledAssociations": True,
"includePrimaryDisplayPropertyForAssociatedObjects": True,
"objectProperties": ["<string>"],
"objectType": "<string>",
"overrideAssociatedObjectsPerDefinitionPerRowLimit": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
associatedObjectType: ['<string>'],
exportInternalValuesOptions: [],
exportName: '<string>',
exportType: 'VIEW',
includeLabeledAssociations: true,
includePrimaryDisplayPropertyForAssociatedObjects: true,
objectProperties: ['<string>'],
objectType: '<string>',
overrideAssociatedObjectsPerDefinitionPerRowLimit: true
})
};
fetch('https://api.hubapi.com/crm/v3/exports/export/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/crm/v3/exports/export/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'associatedObjectType' => [
'<string>'
],
'exportInternalValuesOptions' => [
],
'exportName' => '<string>',
'exportType' => 'VIEW',
'includeLabeledAssociations' => true,
'includePrimaryDisplayPropertyForAssociatedObjects' => true,
'objectProperties' => [
'<string>'
],
'objectType' => '<string>',
'overrideAssociatedObjectsPerDefinitionPerRowLimit' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/crm/v3/exports/export/async"
payload := strings.NewReader("{\n \"associatedObjectType\": [\n \"<string>\"\n ],\n \"exportInternalValuesOptions\": [],\n \"exportName\": \"<string>\",\n \"exportType\": \"VIEW\",\n \"includeLabeledAssociations\": true,\n \"includePrimaryDisplayPropertyForAssociatedObjects\": true,\n \"objectProperties\": [\n \"<string>\"\n ],\n \"objectType\": \"<string>\",\n \"overrideAssociatedObjectsPerDefinitionPerRowLimit\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/v3/exports/export/async")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"associatedObjectType\": [\n \"<string>\"\n ],\n \"exportInternalValuesOptions\": [],\n \"exportName\": \"<string>\",\n \"exportType\": \"VIEW\",\n \"includeLabeledAssociations\": true,\n \"includePrimaryDisplayPropertyForAssociatedObjects\": true,\n \"objectProperties\": [\n \"<string>\"\n ],\n \"objectType\": \"<string>\",\n \"overrideAssociatedObjectsPerDefinitionPerRowLimit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/crm/v3/exports/export/async")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"associatedObjectType\": [\n \"<string>\"\n ],\n \"exportInternalValuesOptions\": [],\n \"exportName\": \"<string>\",\n \"exportType\": \"VIEW\",\n \"includeLabeledAssociations\": true,\n \"includePrimaryDisplayPropertyForAssociatedObjects\": true,\n \"objectProperties\": [\n \"<string>\"\n ],\n \"objectType\": \"<string>\",\n \"overrideAssociatedObjectsPerDefinitionPerRowLimit\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"links": {}
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Required Scopes
Required Scopes
承認
The access token received from the authorization server in the OAuth 2.0 flow.
ボディ
application/json
- Option 1
- Option 2
利用可能なオプション:
NAMES, VALUES 利用可能なオプション:
VIEW 利用可能なオプション:
CSV, XLS, XLSX 利用可能なオプション:
AF_ZA, AR_EG, BG, BN, CA_ES, CS, DA_DK, DE, EL_GR, EN, EN_GB, ES, ES_MX, ET_EE, FI, FR, FR_CA, HE_IL, HI_IN, HR, HU, ID, IT, JA, KO_KR, LT_LT, MS, NL, NO, PL, PT_BR, PT_PT, RO, RU, SK_SK, SL, SV, TH, TL, TR, UK, VI_VN, ZH_CN, ZH_HK, ZH_TW Show child attributes
Show child attributes
最終更新日 2026年4月10日
⌘I