How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot CRM Lists API

HubSpot CRM Lists — 30 operation(s) from HubSpot's published OpenAPI.

HubSpot CRM Lists API is one of 144 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 692 JSON Schema definitions.

Tagged areas include CRM and Lists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 692 JSON Schemas.

This API exposes 30 operations across 23 paths, organized into 3 resource areas, and defines 109 schemas. It is described by OpenAPI 3.0.1, at version 2026-03.

Requests are made against a single base URL, https://api.hubapi.com.

30 operations 23 paths 109 schemas 4 DELETE10 GET5 POST11 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2026-03
Base URL
https://api.hubapi.com
Authentication
API Key, OAuth 2.0, API Key, API Key
Resource Areas
3

Authentication & Security 4

HubSpot CRM Lists API declares 4 security schemes for authenticating requests. An API key is passed in the query as hapikey (developer_hapikey). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes. An API key is passed in the header as private-app (private_apps). An API key is passed in the header as private-app-legacy (private_apps_legacy).

Paths & Operations 30

Across 23 paths, the API surfaces 30 operations — 4 DELETE, 10 GET, 5 POST, 11 PUT. They span 3 resource areas: Basic, Batch, Search. Each is listed below with its method, path, parameters, and response codes.

Basic 28
GET
/crm/lists/2026-03
get-/crm/lists/2026-03_/crm/lists/v3 2 params → 200default
POST
/crm/lists/2026-03
post-/crm/lists/2026-03_/crm/lists/v3 body → 200default
GET
/crm/lists/2026-03/folders
Retrieves a folder.
get-/crm/lists/2026-03/folders_/crm/lists/v3/folders 1 param → 200default
POST
/crm/lists/2026-03/folders
Creates a folder
post-/crm/lists/2026-03/folders_/crm/lists/v3/folders body → 200default
PUT
/crm/lists/2026-03/folders/move-list
Moves a list to a given folder
put-/crm/lists/2026-03/folders/move-list_/crm/lists/v3/folders/move-list body → 204default
DELETE
/crm/lists/2026-03/folders/{folderId}
Deletes a folder
delete-/crm/lists/2026-03/folders/{folderId}_/crm/lists/v3/folders/{folderId} 1 param → 204default
PUT
/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}
Moves a folder
put-/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}_/crm/lists/v3/folders/{folderId}/move/{newParentFolderId} 2 params → 200default
PUT
/crm/lists/2026-03/folders/{folderId}/rename
Rename a folder
put-/crm/lists/2026-03/folders/{folderId}/rename_/crm/lists/v3/folders/{folderId}/rename 2 params → 200default
GET
/crm/lists/2026-03/idmapping
Translate Legacy List Id to Modern List Id
get-/crm/lists/2026-03/idmapping_/crm/lists/v3/idmapping 1 param → 200default
POST
/crm/lists/2026-03/idmapping
Translate Legacy List Id to Modern List Id in Batch
post-/crm/lists/2026-03/idmapping_/crm/lists/v3/idmapping body → 200default
GET
/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}
Fetch List by Name
get-/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}_/crm/lists/v3/object-type-id/{objectTypeId}/name/{listName} 3 params → 200default
GET
/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships
Get lists record is member of
get-/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships_/crm/lists/v3/records/{objectTypeId}/{recordId}/memberships 2 params → 200default
GET
/crm/lists/2026-03/{listId}
Fetch List by ID
get-/crm/lists/2026-03/{listId}_/crm/lists/v3/{listId} 2 params → 200default
DELETE
/crm/lists/2026-03/{listId}
Delete a List
delete-/crm/lists/2026-03/{listId}_/crm/lists/v3/{listId} 1 param → 204default
GET
/crm/lists/2026-03/{listId}/memberships
Fetch List Memberships Ordered by ID
get-/crm/lists/2026-03/{listId}/memberships_/crm/lists/v3/{listId}/memberships 4 params → 200default
DELETE
/crm/lists/2026-03/{listId}/memberships
Delete All Records from a List
delete-/crm/lists/2026-03/{listId}/memberships_/crm/lists/v3/{listId}/memberships 1 param → 204default
PUT
/crm/lists/2026-03/{listId}/memberships/add
Add Records to a List
put-/crm/lists/2026-03/{listId}/memberships/add_/crm/lists/v3/{listId}/memberships/add 1 param body → 200default
PUT
/crm/lists/2026-03/{listId}/memberships/add-and-remove
Add and/or Remove Records from a List
put-/crm/lists/2026-03/{listId}/memberships/add-and-remove_/crm/lists/v3/{listId}/memberships/add-and-remove 1 param body → 200default
PUT
/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}
Add All Records from a Source List to a Destination List
put-/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}_/crm/lists/v3/{listId}/memberships/add-from/{sourceListId} 2 params → 204default
GET
/crm/lists/2026-03/{listId}/memberships/join-order
Fetch List Memberships Ordered by Added to List Date
get-/crm/lists/2026-03/{listId}/memberships/join-order_/crm/lists/v3/{listId}/memberships/join-order 4 params → 200default
PUT
/crm/lists/2026-03/{listId}/memberships/remove
Remove Records from a List
put-/crm/lists/2026-03/{listId}/memberships/remove_/crm/lists/v3/{listId}/memberships/remove 1 param body → 200default
PUT
/crm/lists/2026-03/{listId}/restore
Restore a List
put-/crm/lists/2026-03/{listId}/restore_/crm/lists/v3/{listId}/restore 1 param → 204default
GET
/crm/lists/2026-03/{listId}/schedule-conversion
Retrieve the conversion details for a list
get-/crm/lists/2026-03/{listId}/schedule-conversion_/crm/lists/v3/{listId}/schedule-conversion 1 param → 200default
PUT
/crm/lists/2026-03/{listId}/schedule-conversion
Schedule or update the conversion of a list to static
put-/crm/lists/2026-03/{listId}/schedule-conversion_/crm/lists/v3/{listId}/schedule-conversion 1 param body → 200default
DELETE
/crm/lists/2026-03/{listId}/schedule-conversion
Cancel the conversion of a list
delete-/crm/lists/2026-03/{listId}/schedule-conversion_/crm/lists/v3/{listId}/schedule-conversion 1 param → 204default
GET
/crm/lists/2026-03/{listId}/size-and-edits-history/between
get-/crm/lists/2026-03/{listId}/size-and-edits-history/between_/crm/lists/2026-03/{listId}/size-and-edits-history/between 3 params → 200default
PUT
/crm/lists/2026-03/{listId}/update-list-filters
Update List Filter Definition
put-/crm/lists/2026-03/{listId}/update-list-filters_/crm/lists/v3/{listId}/update-list-filters 2 params body → 200default
PUT
/crm/lists/2026-03/{listId}/update-list-name
Update List Name
put-/crm/lists/2026-03/{listId}/update-list-name_/crm/lists/v3/{listId}/update-list-name 3 params → 200default
Batch 1
POST
/crm/lists/2026-03/records/memberships/batch/read
post-/crm/lists/2026-03/records/memberships/batch/read_/crm/lists/v3/records/memberships/batch/read body → 200207default
Search 1
POST
/crm/lists/2026-03/search
Search Lists
post-/crm/lists/2026-03/search_/crm/lists/v3/search body → 200default

Schemas 109

The contract defines 109 schemas that model the data the API accepts and returns. The most detailed are PublicObjectList (16 properties), PublicObjectListSearchResult (13 properties), PublicDatePoint (10 properties), PublicListFolder (9 properties). Each schema is shown below with its type and property counts.

ApiCollectionResponseJoinTimeAndRecordId
object
3 properties 1 required
ApiCollectionResponseRecordListMembership
object
3 properties 1 required
BatchInputRecordIdInput
object
1 property 1 required
BatchResponseRecordIdWithMemberships
object
6 properties 4 required
BatchResponseRecordIdWithMembershipsWithErrors
object
8 properties 4 required
Error
object
Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the…
7 properties 3 required
ErrorDetail
object
Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typic…
5 properties 1 required
JoinTimeAndRecordId
object
2 properties 2 required
ListCreateRequest
object
8 properties 3 required
ListCreateResponse
object
1 property 1 required
ListFetchResponse
object
1 property 1 required
ListFilterUpdateRequest
object
1 property 1 required
ListFolderCreateRequest
object
2 properties 1 required
ListFolderCreateResponse
object
1 property 1 required
ListFolderFetchResponse
object
1 property 1 required
ListMoveRequest
object
2 properties 2 required
ListSearchRequest
object
8 properties 4 required
ListSearchResponse
object
4 properties 4 required
ListSizeAndEditHistoryResponse
object
2 properties 2 required
ListSizeDataPoint
object
2 properties 2 required
ListUpdateResponse
object
1 property
ListsByIdResponse
object
1 property 1 required
MembershipChangeRequest
object
2 properties 2 required
MembershipsUpdateResponse
object
3 properties 3 required
NextPage
object
Specifies the paging information needed to retrieve the next set of results in a paginated API response
2 properties 1 required
Paging
object
2 properties
PreviousPage
object
specifies the paging information needed to retrieve the previous set of results in a paginated API response
2 properties 1 required
PublicAbsoluteComparativeTimestampRefineBy
object
3 properties 3 required
PublicAbsoluteRangedTimestampRefineBy
object
4 properties 4 required
PublicAdsSearchFilter
object
6 properties 6 required
PublicAdsTimeFilter
object
2 properties 2 required
PublicAllHistoryRefineBy
object
1 property 1 required
PublicAllPropertyTypesOperation
object
3 properties 3 required
PublicAndFilterBranch
object
4 properties 4 required
PublicAssociationFilterBranch
object
8 properties 8 required
PublicAssociationInListFilter
object
8 properties 6 required
PublicBatchMigrationMapping
object
2 properties 2 required
PublicBoolPropertyOperation
object
4 properties 4 required
PublicCalendarDatePropertyOperation
object
7 properties 4 required
PublicCommunicationSubscriptionFilter
object
6 properties 5 required
PublicComparativeDatePropertyOperation
object
5 properties 4 required
PublicComparativePropertyUpdatedOperation
object
5 properties 4 required
PublicComparativeStringPropertyOperation
object
5 properties 4 required
PublicConstantFilter
object
3 properties 2 required
PublicCtaAnalyticsFilter
object
5 properties 3 required
PublicDatePoint
object
10 properties 5 required
PublicDatePropertyOperation
object
6 properties 6 required
PublicDateTimePropertyOperation
object
5 properties 5 required
PublicEmailEventFilter
object
7 properties 5 required
PublicEmailSubscriptionFilter
object
4 properties 3 required
PublicEnumerationPropertyOperation
object
4 properties 4 required
PublicEventAnalyticsFilter
object
5 properties 3 required
PublicEventFilterMetadata
object
2 properties 2 required
PublicFiscalQuarterReference
object
7 properties 3 required
PublicFiscalYearReference
object
7 properties 3 required
PublicFormSubmissionFilter
object
5 properties 2 required
PublicFormSubmissionOnPageFilter
object
6 properties 3 required
PublicInListFilter
object
4 properties 3 required
PublicInListFilterMetadata
object
2 properties 2 required
PublicIndexOffset
object
9 properties
PublicIndexedTimePoint
object
5 properties 3 required
PublicIntegrationEventFilter
object
3 properties 3 required
PublicListConversionDate
object
4 properties 4 required
PublicListConversionInactivity
object
3 properties 3 required
PublicListConversionResponse
object
3 properties 1 required
PublicListConversionTime
PublicListFolder
object
9 properties 4 required
PublicListPermissions
object
2 properties 2 required
PublicMembershipSettings
object
2 properties
PublicMigrationMapping
object
2 properties 2 required
PublicMonthReference
object
6 properties 2 required
PublicMultiStringPropertyOperation
object
4 properties 4 required
PublicNotAllFilterBranch
object
4 properties 4 required
PublicNotAnyFilterBranch
object
4 properties 4 required
PublicNowReference
object
5 properties 1 required
PublicNumOccurrencesRefineBy
object
3 properties 1 required
PublicNumberPropertyOperation
object
4 properties 4 required
PublicObjectList
object
16 properties 6 required
PublicObjectListSearchResult
object
13 properties 7 required
PublicOrFilterBranch
object
4 properties 4 required
PublicPageViewAnalyticsFilter
object
6 properties 3 required
PublicPrivacyAnalyticsFilter
object
3 properties 3 required
PublicPropertyFilter
object
3 properties 3 required
PublicPropertyReferencedTime
object
5 properties 4 required
PublicQuarterReference
object
7 properties 3 required
PublicRangedDatePropertyOperation
object
6 properties 6 required
PublicRangedNumberPropertyOperation
object
5 properties 5 required
PublicRangedTimeOperation
object
9 properties 6 required
PublicRelativeComparativeTimestampRefineBy
object
3 properties 3 required
PublicRelativeRangedTimestampRefineBy
object
4 properties 4 required
PublicRestrictedFilterBranch
object
4 properties 4 required
PublicRollingDateRangePropertyOperation
object
5 properties 5 required
PublicRollingPropertyUpdatedOperation
object
4 properties 4 required
PublicSetOccurrencesRefineBy
object
2 properties 2 required
PublicStringPropertyOperation
object
4 properties 4 required
PublicSurveyMonkeyFilter
object
3 properties 3 required
PublicSurveyMonkeyValueFilter
object
7 properties 5 required
PublicTimeOffset
object
3 properties 3 required
PublicTimePointOperation
object
7 properties 5 required
PublicTodayReference
object
5 properties 1 required
PublicUnifiedEventsFilter
object
5 properties 2 required
PublicUnifiedEventsFilterBranch
object
8 properties 6 required
PublicWebinarFilter
object
3 properties 2 required
PublicWeekReference
object
6 properties 2 required
PublicYearReference
object
7 properties 3 required
RecordIdInput
object
2 properties 2 required
RecordIdWithMemberships
object
3 properties 3 required
RecordListMembership
object
5 properties 4 required
StandardError
object
Ye olde error
8 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-crm-lists-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API
HubSpot Workflows API
Where this information came from

This is an independent, third-party profile of HubSpot CRM Lists API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.