Basic

Retrieve ID Mapping

Changed on

Retrieve the mapping of legacy list IDs to their current IDs in the HubSpot system. This endpoint is useful for migrating or updating systems that rely on legacy list identifiers.

get/crm/lists/2026-09/idmapping

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/lists/2026-09/idmapping
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.segments.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.lists.read

Query parameters

legacyListIdstring

The legacy list ID for which you want to retrieve the current ID mapping.

Response

successful operation

legacyListIdstring required

The legacy list ID from the previous system. This is a string that represents the list ID in the legacy system.

listIdstring required

The new list ID in the HubSpot system. This is a string that uniquely identifies the list in the current system.

Changes

  • 2026-09e1dd745172d1Revision changes
    • info

      the security scope crm.segments.read was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.lists.read was removed from the endpoint's security scheme oauth2

    • info

      the security scope crm.segments.read was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.lists.read was removed from the endpoint's security scheme oauth2