Account & Settings
アプリ管理
自動化
CMS
Communication preferences
コミュニケーション
CRM
- HubSpot CRM embed
- CRM search
- Understanding the CRM APIs
- Using Object APIs
- Lists (Segments) API
- List (segment) filters overview
- POSTCreate list
- GETRetrieve a list by ID
- GETRetrieve a list by name
- GETRetrieve lists
- PUTRestore list
- POSTSearch Lists
- PUTUpdate List Name
- List API migration guide
- DELDelete a list
- GETGet a group of contact lists
- GETGet dynamic contact lists
- GETGet a contact list by its unique ID
- GETGet contacts in a list
- GETGet recently added contacts from a list
- GETGet static contact lists
- GETGet all contact lists
- POSTUpdate a contact list
- POSTAdd existing contacts to a list
- POSTRemove an existing contact from a list
- POSTCreate a new contact list
- DELDelete a contact list
ファイル
マーケティング
レポート
Scheduler
curl --request GET \
--url https://api.hubapi.com/contacts/v1/lists/{list_id}/contacts/all{
"contacts": [
{
"vid": 123,
"canonical-vid": 123,
"merged-vids": [
123
],
"portal-id": 123,
"is-contact": true,
"addedAt": 123,
"properties": {},
"form-submissions": [
{}
],
"identity-profiles": [
{}
],
"merge-audits": [
{}
]
}
],
"has-more": true,
"vid-offset": 123
}Get contacts in a list
This endpoint will return a list of contacts on a particular list (identified by its unique ID) in a given account. Use case for this endpoint: HubSpot customers generally use lists to group similar contacts together for marketing automation.
curl --request GET \
--url https://api.hubapi.com/contacts/v1/lists/{list_id}/contacts/all{
"contacts": [
{
"vid": 123,
"canonical-vid": 123,
"merged-vids": [
123
],
"portal-id": 123,
"is-contact": true,
"addedAt": 123,
"properties": {},
"form-submissions": [
{}
],
"identity-profiles": [
{}
],
"merge-audits": [
{}
]
}
],
"has-more": true,
"vid-offset": 123
}パスパラメータ
Unique identifier for the list you're looking for.
クエリパラメータ
This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter is 20 contacts. The maximum amount of contacts you can have returned is 100.
x <= 100Used to page through the contacts. Every call to this endpoint will return a vid-offset value. This value is used in the vidOffset parameter of the next call to get the next page of contacts.
If you include the "property" parameter, then the properties in the "contact" object in the returned data will only include the property or properties that you request.
One of "value_only" or "value_and_history" to specify if the current value for a property should be fetched, or the value and all the historical values for that property.
value_only, value_and_history One of "all", "none", "newest", "oldest" to specify which form submissions should be fetched.
all, none, newest, oldest Boolean to indicate whether current list memberships should be fetched for the contact.