Zum Hauptinhalt springen
GET
/
crm
/
v3
/
lists
/
object-type-id
/
{objectTypeId}
/
name
/
{listName}
名前でリストを取得
curl --request GET \
  --url https://api.hubapi.com/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName} \
  --header 'Authorization: Bearer <token>'
{
  "list": {
    "createdAt": "2023-11-15T18:10:11.793Z",
    "createdById": "123",
    "filtersUpdatedAt": "2023-11-15T18:10:11.793Z",
    "listId": "1",
    "listVersion": 1,
    "name": "Manual List Example",
    "objectTypeId": "0-1",
    "processingStatus": "COMPLETE",
    "processingType": "MANUAL",
    "size": 330,
    "updatedAt": "2023-11-15T18:10:11.923Z",
    "updatedById": "123"
  }
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
crm.lists.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
listName
string
required

取得するリストの名前。大文字と小文字は区別されません。

​
objectTypeId
string
required

取得するリストに保存されるオブジェクトタイプのオブジェクトタイプID。例えば、「コンタクト」リストでは「0～1」になります。

Query Parameters

​
includeFilters
boolean
default:false

レスポンスオブジェクトリスト定義にフィルター分岐定義が含まれている必要があるかどうかを示すフラグ。既定では、オブジェクトリスト定義のフィルター分岐定義はレスポンスに含まれません。

Response

Successful response, for a request with includeFilters set to false.

The response for a list fetch request.

​
list
object
required

An object list definition.