> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nutshell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get lead products

A product map is an instance of a product attached to a lead, including quantity and custom pricing information. This endpoint returns all mappings between products and leads.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Nutshell API",
    "description": "The most powerful API in the world",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "app.nutshell.com/rest"
    }
  ],
  "paths": {
    "/productmaps": {
      "get": {
        "tags": [
          "Products"
        ],
        "summary": "Get lead products",
        "description": "A product map is an instance of a product attached to a lead, including quantity and custom pricing information. This endpoint returns all mappings between products and leads.",
        "operationId": "4bc737ff6f91aab43dc7617f2c36ab3c",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LeadProductMapResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "value": {
        "properties": {
          "formatted": {
            "description": "The value formatted as a string",
            "type": "string",
            "example": "$100.00"
          },
          "amount": {
            "description": "The value as a number",
            "type": "string",
            "example": "100.00"
          },
          "currency": {
            "description": "The currency code",
            "type": "string",
            "example": "USD"
          }
        },
        "type": "object"
      },
      "LeadProductMapResponse": {
        "description": "A full response object for a lead product map.",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/meta"
          },
          "productMaps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LeadProductMap"
            }
          }
        },
        "type": "object"
      },
      "LeadProductMap": {
        "properties": {
          "id": {
            "description": "The API ID of this entity, formatted {integer}-{entityType}",
            "type": "string",
            "example": "3-contacts"
          },
          "relationship": {},
          "price": {
            "$ref": "#/components/schemas/value"
          },
          "name": {},
          "unit": {},
          "quantity": {
            "type": "integer"
          },
          "productType": {
            "type": "string",
            "example": "product"
          },
          "links": {
            "properties": {
              "product": {
                "description": "The product this map is for",
                "type": "string",
                "example": "1-products"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "meta": {
        "description": "Information about the Nutshell instance making the request",
        "properties": {
          "instanceId": {
            "description": "The Nutshell instance ID",
            "type": "string",
            "example": "12345"
          },
          "siteId": {
            "description": "Site ID for WebFX customers",
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "tags": [
    {
      "name": "Products",
      "description": "Products"
    }
  ]
}
```