Zum Hauptinhalt springen
GET
/
crm
/
v3
/
lists
/
object-type-id
/
{objectTypeId}
/
name
/
{listName}
Liste anhand des Namens abrufen
curl --request GET \
  --url https://api.hubapi.com/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName} \
  --header 'private-app: <api-key>'
{
  "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"
  }
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Starter
Diese API erfordert einen der folgenden Bereiche:
crm.lists.read

Authorizations

private-app
string
header
required

Path Parameters

listName
string
required

Der Name der abzurufenden Liste. Zwischen Groß- und Kleinschreibung wird nicht unterschieden.

objectTypeId
string
required

Die Objekttyp-ID der Objekttypen, die in der abzurufenden Liste gespeichert sind. Beispiel: „0-1“ für eine „CONTACT“-Liste.

Query Parameters

includeFilters
boolean
default:false

Ein Flag, das angibt, ob die Definition der Antwortobjektliste eine Definition der Filterverzweigung enthalten soll oder nicht. Standardmäßig werden bei Objektlistendefinitionen keine Definitionen der Filterverzweigung in die Antwort aufgenommen.

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.