MyLists v1

Active 3-legged

Create and manage saved product lists, BOMs, and shared collections associated with a DigiKey user account.

https://api.digikey.com/mylists/v1 OpenAPI spec →

Endpoints

Method	Path	Description
GET	`/lists`	List all saved lists for the account
POST	`/lists`	Create a new list
GET	`/lists/{listId}`	Get list detail and parts
PUT	`/lists/{listId}`	Update list settings
DELETE	`/lists/{listId}`	Delete a list
PUT	`/lists/{listId}/listName/{listName}`	Rename a list
GET	`/lists/{listId}/parts`	Get parts in a list
POST	`/lists/{listId}/parts`	Add a part to a list
PUT	`/lists/{listId}/parts/{uniqueId}`	Update a part in a list
DELETE	`/lists/{listId}/parts/{uniqueId}`	Remove a part from a list
GET	`/lists/validate/name/{listName}`	Check if a list name is available

GET /lists

Returns all lists for the authenticated user's account.

Response

From a live capture:

[
  {
    "Id": "YVF169DUPI",
    "ListName": "robot-interface-tester - Copy",
    "CustomerId": 4530750,
    "AccountId": 4530750,
    "FirstName": "BEN",
    "LastName": "HEST",
    "TotalParts": 26,
    "DateCreated": "2023-08-03T13:29:44.847",
    "DateLastAccessed": "2026-03-26T02:16:53.237",
    "Tags": [],
    "ListSettings": {
      "Visibility": "private",
      "PackagePreference": "cutTapeOrTR",
      "AutoCorrectQuantities": false
    },
    "CanEdit": true
  }
]

Use Id to retrieve list detail or add parts.

POST /lists — Create a list

Request

{
  "ListName": "Q2 BOM - Motor Controller",
  "Notes": "Components for the Q2 motor controller project",
  "ListSettings": {
    "Visibility": "private",
    "PackagePreference": "cutTapeOrTR"
  }
}

Response

{
  "Id": "2TMJKXLVK0",
  "ListName": "Q2 BOM - Motor Controller",
  "CustomerId": 4530750,
  "TotalParts": 0,
  "DateCreated": "2026-03-26T01:29:57.809Z",
  "ListSettings": {
    "Visibility": "private",
    "PackagePreference": "cutTapeOrTR",
    "AutoCorrectQuantities": false
  },
  "CanEdit": true
}

GET /lists/{listId}

Returns the full list detail including parts, settings, and metadata.

Path parameter: listId — the Id value from the lists response (e.g. YVF169DUPI).

Response (empty list)

{
  "Id": "2TMJKXLVK0",
  "ListName": "Q2 BOM - Motor Controller",
  "CreatedBy": "142941",
  "CustomerId": 4530750,
  "TotalParts": 0,
  "DateCreated": "2026-03-26T01:29:57.809Z",
  "DateLastAccessed": "2026-03-26T01:31:11.7Z",
  "Tags": [],
  "ListSettings": {
    "Visibility": "private",
    "PackagePreference": "cutTapeOrTR",
    "ColumnPreferences": [],
    "AutoCorrectQuantities": false,
    "AttritionEnabled": false,
    "AutoPopulateCref": false
  },
  "PartsList": [],
  "CanEdit": true
}

POST /lists/{listId}/parts — Add a part

{
  "DigiKeyPartNumber": "311-10.0KHRCT-ND",
  "Quantity": 100,
  "CustomerReference": "R15"
}

List visibility

Value	Description
`private`	Visible only to the creating account
`shared`	Visible to other users in the same company account
`public`	Accessible via a share link

Notes

MyLists v1 requires 3-legged authentication. The list is associated with the DigiKey account of the authenticated user. A 2-legged token will return 401.

Models

Request and response object schemas for this API. Error models (ApiErrorResponse, DKProblemDetails) are documented on the Authentication & Concepts page.

`CreateListRequest`

Information need for creating a new MyList

Field	Type	Required	Description
`ListName`	string	required	Gets or sets name of the new list
`CreatedBy`	string		Gets or sets who the list was created by (rep or customer)
`Tags`	array of string		Gets or sets assigns any tags entered to the newly created list
`Source`	string		Gets or Sets Source One of: `other`, `internal`, `external`, `mobile`, `search`, `b2b`
`ListSettings`	ListSettings
`RefList`	ReferenceList

`ListData`

Field	Type	Required	Description
`Id`	string
`ListName`	string
`CreatedBy`	string
`CustomerId`	integer (int32)
`AccountId`	integer (int32)
`CompanyName`	string
`FirstName`	string
`LastName`	string
`Notes`	string
`TotalParts`	integer (int32)
`DateCreated`	string (date-time)
`DateLastAccessed`	string (date-time)
`DateModified`	string (date-time)
`Tags`	array of string
`ListSettings`	ListSettings
`PartsList`	array of RequestedPart
`Revisions`	array of Revision
`CanEdit`	boolean
`UserInformation`	UserInformation

`ListPart`

Field	Type	Description
`PartId`	integer (int32)
`UniqueId`	string
`CustomerReference`	string
`ReferenceDesignator`	string
`Notes`	string
`MinOrderQty`	integer (int32)
`MaxOrderQty`	integer (int64)
`OriginalPartNumber`	string
`RequestedPartNumber`	string
`DigiKeyPartNumber`	string
`ManufacturerPartNumber`	string
`RequestedManufacturerName`	string
`Manufacturer`	string
`Description`	string
`PartStatus`	string
`PartStatusCode`	integer (int32)	One of: `Active`, `Obsolete`, `Discontinued`, `ComingSoon`, `LastTimeBuy`, `NotForNewDesigns`
`Availability`	string
`TariffCode`	integer (int32)	One of: `NoTariff`, `TariffPending`, `TariffApplied`
`QuantityAvailable`	integer (int32)
`SelectedQuantityIndex`	integer (int32)
`Attrition`	number (double)
`Quantities`	array of ListPartQuantity
`VendorLeadWeeks`	integer (int32)
`PartDetailUrl`	string
`PrimaryDatasheetUrl`	string
`ImageUrl`	string
`ThumbnailUrl`	string
`MarketPlaceSupplierLink`	string
`SupplierName`	string
`Substitutes`	array of PartOption
`AlternateParts`	array of PartOption
`Flags`	ListPartFlags
`ReachStatus`	string
`RohsStatusMessage`	string
`Eccn`	string
`Htsus`	string
`CountryOfOrigin`	string
`EnvironmentalDocs`	object
`Category`	string
`PartsAvailableForCref`	array of CrefPartOption
`CrefsAvailableForPart`	array of string

`PartsByListIdResponse`

Field	Type	Required	Description
`PartsList`	array of ListPart
`TotalParts`	integer (int32)

`RequestedPart`

Field	Type	Required	Description
`UniqueId`	string
`PartId`	integer (int32)
`RequestedPartNumber`	string
`OriginalPartNumber`	string
`ManufacturerName`	string
`CustomerReference`	string
`ReferenceDesignator`	string
`Notes`	string
`SelectedQuantityIndex`	integer (int32)
`Attrition`	number (double)
`AlternateParts`	array of string
`Quantities`	array of RequestedQuantity