> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Search Lists > Pesquise listas pelo nome ou navegue por todas as listas fornecendo um valor vazio para "query". > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/crm-lists-v3.json POST /crm/v3/lists/search openapi: 3.0.1 info: title: CRM Lists description: CRUD operations to manage lists and list memberships version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-related-documentation: - name: Lists Guide url: https://developers.hubspot.com/docs/guides/api/crm/lists/overview servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Batch - name: Search paths: /crm/v3/lists/search: post: tags: - Search summary: Pesquisar listas description: >- Pesquise listas pelo nome ou navegue por todas as listas fornecendo um valor vazio para "query". operationId: post-/crm/v3/lists/search_/crm/v3/lists/search parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ListSearchRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ListSearchResponse' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.segments.read - oauth2: - crm.lists.read components: schemas: ListSearchRequest: required: - additionalProperties - offset type: object properties: additionalProperties: type: array description: >- Os nomes das propriedades de qualquer propriedade de lista adicional a ser incluída na resposta. Propriedades que não existem ou que estão vazias para uma lista específica não são incluídas na resposta. Por padrão, todas as solicitações buscarão as seguintes propriedades para cada lista: "hs_list_size", "hs_last_record_added_at", "hs_last_record_removed_at", "hs_folder_name" e "hs_list_reference_count". items: type: string count: type: integer description: >- O número de listas a serem incluídas na resposta. O padrão é "20" se nenhum valor for fornecido. O valor máximo de "count" é "500". format: int32 listIds: type: array description: >- IDs de lista ILS a serem incluídos nos resultados da pesquisa. Se não especificado, todas as listas que corresponderem a outros critérios serão incluídas items: type: string objectTypeId: type: string offset: type: integer description: >- Valor usado para paginar listas. O "offset" fornecido na resposta pode ser usado na próxima solicitação para buscar a próxima página de resultados. O padrão é "0" se nenhum ajuste for fornecido. format: int32 processingTypes: type: array description: >- Liste os tipos de processamento a serem incluídos nos resultados da pesquisa. Se não for especificado, todas as listas com todos os tipos de processamento serão incluídas. items: type: string query: type: string description: >- A "query" que será usada para procurar listas pelo nome da lista. Se nenhuma "query" for fornecida, os resultados incluirão todas as listas. sort: type: string description: Classificar campo e ordem description: The request object used for searching through lists. example: additionalProperties: - hs_list_size_week_delta count: 100 offset: 0 query: Test ListSearchResponse: required: - hasMore - lists - offset - total type: object properties: hasMore: type: boolean description: Se há ou não mais resultados para navegar. lists: type: array description: As listas que corresponderam aos critérios de pesquisa. items: $ref: '#/components/schemas/PublicObjectListSearchResult' offset: type: integer description: >- Valor a ser transmitido em uma solicitação futura para paginar os resultados da pesquisa de lista. format: int32 total: type: integer description: O número total de listas que correspondem aos critérios de pesquisa. format: int32 description: >- The response object with the list search hits and additional information regarding pagination. example: hasMore: false lists: - additionalProperties: hs_last_record_added_at: '1695938616824' hs_list_reference_count: '0' hs_list_size: '59' hs_list_size_week_delta: '-10' createdAt: '2023-09-28T22:03:17.998Z' createdById: '1' filtersUpdatedAt: '2023-09-28T22:03:17.998Z' listId: '123' listVersion: 1 name: Test list objectTypeId: 0-1 processingStatus: COMPLETE processingType: SNAPSHOT updatedAt: '2023-09-28T22:03:37.005Z' updatedById: '1' offset: 1 total: 1 PublicObjectListSearchResult: required: - additionalProperties - listId - listVersion - name - objectTypeId - processingStatus - processingType type: object properties: additionalProperties: type: object additionalProperties: type: string description: >- O nome e o valor de propriedades adicionais que existem para esta lista e que foram incluídos na solicitação de pesquisa. createdAt: type: string description: A hora em que a lista foi criada. format: date-time createdById: type: string description: O ID do usuário que criou a lista. deletedAt: type: string description: A hora em que a lista foi excluída. format: date-time filtersUpdatedAt: type: string description: >- A hora em que os filtros desta lista foram atualizadas pela última vez. format: date-time listId: type: string description: O **ID ILS** da lista. listVersion: type: integer description: A versão da lista. format: int32 name: type: string description: O nome da lista. objectTypeId: type: string description: O tipo de objeto da lista. processingStatus: type: string description: O status de processamento da lista. processingType: type: string description: O tipo de processamento da lista. updatedAt: type: string description: A hora em que a lista foi atualizada pela última vez. format: date-time updatedById: type: string description: O ID do usuário que atualizou a lista. example: additionalProperties: hs_last_record_added_at: 1695938616824 hs_list_reference_count: 0 hs_list_size: 59 hs_list_size_week_delta: -1 createdAt: '2023-09-28T22:03:17.998Z' createdById: '1' filtersUpdatedAt: '2023-09-28T22:03:17.998Z' listId: '123' listVersion: 1 name: Test list objectTypeId: 0-1 processingStatus: COMPLETED processingType: SNAPSHOT updatedById: '1' Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: cms.membership.access_groups.write: '' crm.lists.read: '' crm.lists.write: '' crm.segments.read: '' crm.segments.write: '' ````