younifyd
Menu

Get /crm/v3/lists/{list Id} /crm/v3/lists/{list Id}

Fetch List by ID

GET/crm/v3/lists/{listId}

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Get /crm/v3/lists/{list Id} /crm/v3/lists/{list Id} action (under Lists).
  3. Fill in the fields below, then reference the result from later steps as {{getCrmV3ListsListIdCrmV3ListsListId.response.data}}.

Request

Path parameters

listIdstringrequired

The **ILS ID** of the list to fetch.

Query parameters

includeFiltersboolean

A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.

Default false

Response

Returns 200 with an object. Read it in later steps with {{getCrmV3ListsListIdCrmV3ListsListId.response.data.<field>}}.

listobject

An object list definition.

createdAtstring (date-time)

The time when the list was created.

createdByIdstring

The ID of the user that created the list.

deletedAtstring (date-time)

The time when the list was deleted.

filterBranchoneOf

Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership.

filtersUpdatedAtstring (date-time)

The time when the filters for this list were last updated.

listIdstringrequired

The **ILS ID** of the list.

listPermissionsobject2 fields
listVersioninteger (int32)required

The version of the list.

membershipSettingsobject2 fields
namestringrequired

The name of the list.

objectTypeIdstringrequired

The object type of the list.

processingStatusstringrequired

The processing status of the list.

processingTypestringrequired

The processing type of the list.

sizeinteger (int64)

Size of the list

updatedAtstring (date-time)

The time the list was last updated.

updatedByIdstring

The ID of the user that last updated the list.

json
{
  "list": {
    "listId": "string",
    "listVersion": 0,
    "name": "string",
    "objectTypeId": "string",
    "processingStatus": "string",
    "processingType": "string",
    "createdAt": "2025-01-01T00:00:00Z",
    "createdById": "string",
    "deletedAt": "2025-01-01T00:00:00Z",
    "filterBranch": null,
    "filtersUpdatedAt": "2025-01-01T00:00:00Z",
    "listPermissions": {
      "teamsWithEditAccess": [
        0
      ],
      "usersWithEditAccess": [
        0
      ]
    }
  }
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.