---
name: crm-lists
description: "CRM Lists API skill. Use when working with CRM Lists for crm. Covers 30 endpoints."
version: 1.0.0
generator: lapsh
---

# CRM Lists
API version: v3

## Auth
OAuth2 | ApiKey private-app in header

## Base URL
https://api.hubapi.com

## Setup
1. Set your API key in the appropriate header
2. GET /crm/lists/v3 -- verify access
3. POST /crm/lists/v3 -- create first list

## Endpoints
30 endpoints across 1 group. See references/api-spec.lap for full details.

### Crm
| Method | Path | Description |
|--------|------|-------------|
| GET | /crm/lists/v3 |  |
| POST | /crm/lists/v3 |  |
| GET | /crm/lists/v3/folders |  |
| POST | /crm/lists/v3/folders |  |
| PUT | /crm/lists/v3/folders/move-list |  |
| DELETE | /crm/lists/v3/folders/{folderId} |  |
| PUT | /crm/lists/v3/folders/{folderId}/move/{newParentFolderId} |  |
| PUT | /crm/lists/v3/folders/{folderId}/rename |  |
| GET | /crm/lists/v3/idmapping |  |
| POST | /crm/lists/v3/idmapping |  |
| GET | /crm/lists/v3/object-type-id/{objectTypeId}/name/{listName} | Retrieve List by Name |
| POST | /crm/lists/v3/records/memberships/batch/read |  |
| GET | /crm/lists/v3/records/{objectTypeId}/{recordId}/memberships |  |
| POST | /crm/lists/v3/search |  |
| GET | /crm/lists/v3/{listId} |  |
| DELETE | /crm/lists/v3/{listId} |  |
| GET | /crm/lists/v3/{listId}/memberships |  |
| DELETE | /crm/lists/v3/{listId}/memberships |  |
| PUT | /crm/lists/v3/{listId}/memberships/add |  |
| PUT | /crm/lists/v3/{listId}/memberships/add-and-remove |  |
| PUT | /crm/lists/v3/{listId}/memberships/add-from/{sourceListId} |  |
| GET | /crm/lists/v3/{listId}/memberships/join-order |  |
| PUT | /crm/lists/v3/{listId}/memberships/remove |  |
| PUT | /crm/lists/v3/{listId}/restore |  |
| GET | /crm/lists/v3/{listId}/schedule-conversion |  |
| PUT | /crm/lists/v3/{listId}/schedule-conversion |  |
| DELETE | /crm/lists/v3/{listId}/schedule-conversion |  |
| GET | /crm/lists/v3/{listId}/size-and-edits-history/between |  |
| PUT | /crm/lists/v3/{listId}/update-list-filters |  |
| PUT | /crm/lists/v3/{listId}/update-list-name |  |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all lists?" -> GET /crm/lists/v3
- "Create a list?" -> POST /crm/lists/v3
- "List all folders?" -> GET /crm/lists/v3/folders
- "Create a folder?" -> POST /crm/lists/v3/folders
- "Delete a folder?" -> DELETE /crm/lists/v3/folders/{folderId}
- "Update a move?" -> PUT /crm/lists/v3/folders/{folderId}/move/{newParentFolderId}
- "List all idmapping?" -> GET /crm/lists/v3/idmapping
- "Create a idmapping?" -> POST /crm/lists/v3/idmapping
- "Get name details?" -> GET /crm/lists/v3/object-type-id/{objectTypeId}/name/{listName}
- "Create a read?" -> POST /crm/lists/v3/records/memberships/batch/read
- "List all memberships?" -> GET /crm/lists/v3/records/{objectTypeId}/{recordId}/memberships
- "Create a search?" -> POST /crm/lists/v3/search
- "Get list details?" -> GET /crm/lists/v3/{listId}
- "Delete a list?" -> DELETE /crm/lists/v3/{listId}
- "Update a add-from?" -> PUT /crm/lists/v3/{listId}/memberships/add-from/{sourceListId}
- "List all join-order?" -> GET /crm/lists/v3/{listId}/memberships/join-order
- "List all schedule-conversion?" -> GET /crm/lists/v3/{listId}/schedule-conversion
- "List all between?" -> GET /crm/lists/v3/{listId}/size-and-edits-history/between
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Paginated endpoints accept limit/offset or cursor parameters
- Create/update endpoints return the modified resource on success

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)