> ## 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 for payments > Pesquise objetos do CRM de um tipo especificado usando os critérios de pesquisa fornecidos. Este endpoint permite filtrar e classificar objetos com base em várias propriedades, tornando-o útil para recuperar conjuntos de dados específicos do CRM. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/crm-commerce-payments-v2026-09.json POST /crm/objects/2026-09/commerce_payments/search openapi: 3.0.1 info: title: CRM Commerce Payments description: Basepom for all HubSpot Projects version: 2026-09 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE servers: - url: https://api.hubapi.com security: [] tags: - name: Advanced - name: Basic - name: Batch - name: Search paths: /crm/objects/2026-09/commerce_payments/search: post: tags: - Search summary: Pesquisar objetos description: >- Pesquise objetos do CRM de um tipo especificado usando os critérios de pesquisa fornecidos. Este endpoint permite filtrar e classificar objetos com base em várias propriedades, tornando-o útil para recuperar conjuntos de dados específicos do CRM. operationId: >- post-/crm/objects/2026-09/commerce_payments/search_/crm/objects/2026-09-beta/{objectType}/search parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicObjectSearchRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/CollectionResponseWithTotalSimplePublicObject default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.objects.deals.read - oauth2: - crm.objects.subscriptions.read - oauth2: - crm.objects.services.read - oauth2: - crm.objects.tickets.sensitive.read - oauth2: - crm.objects.orders.read - oauth2: - crm.objects.listings.write - oauth2: - crm.objects.custom.read - oauth2: - crm.objects.companies.write - oauth2: - crm.objects.tasks.read - oauth2: - crm.objects.custom.sensitive.write.v2 - oauth2: - crm.objects.custom.highly_sensitive.write.v2 - oauth2: - crm.objects.companies.read - oauth2: - crm.objects.appointments.sensitive.read.v2 - oauth2: - crm.objects.contacts.highly_sensitive.read.v2 - oauth2: - crm.objects.tickets.highly_sensitive.read - oauth2: - crm.objects.companies.sensitive.read.v2 - oauth2: - crm.objects.tickets.sensitive.write - oauth2: - media_bridge.read - oauth2: - crm.objects.deals.highly_sensitive.read.v2 - oauth2: - crm.objects.contacts.highly_sensitive.write.v2 - oauth2: - crm.objects.companies.highly_sensitive.read.v2 - oauth2: - crm.objects.commercepayments.write - oauth2: - crm.objects.invoices.write - oauth2: - crm.objects.contacts.sensitive.write.v2 - oauth2: - crm.objects.calls.read - oauth2: - crm.objects.users.write - oauth2: - crm.objects.meetings.read - oauth2: - crm.objects.custom.sensitive.read.v2 - oauth2: - crm.objects.users.read - oauth2: - crm.objects.partner-services.read - oauth2: - crm.objects.orders.write - oauth2: - crm.objects.partner-services.write - oauth2: - crm.objects.appointments.write - oauth2: - crm.objects.projects.highly_sensitive.write - oauth2: - crm.objects.carts.write - oauth2: - crm.objects.tickets.highly_sensitive.write - oauth2: - crm.objects.commercepayments.read - oauth2: - crm.objects.products.write - oauth2: - crm.objects.feedback_submissions.read - oauth2: - crm.objects.services.write - oauth2: - crm.objects.subscriptions.write - oauth2: - crm.objects.deals.sensitive.write.v2 - oauth2: - crm.objects.contacts.read - oauth2: - crm.objects.appointments.sensitive.write.v2 - oauth2: - crm.objects.projects.highly_sensitive.read - oauth2: - crm.objects.invoices.read - oauth2: - crm.objects.custom.write - oauth2: - tickets.sensitive.v2 - oauth2: - crm.objects.deals.write - oauth2: - e-commerce - oauth2: - crm.objects.appointments.read - oauth2: - crm.objects.projects.read - oauth2: - crm.objects.companies.sensitive.write.v2 - oauth2: - crm.objects.companies.highly_sensitive.write.v2 - oauth2: - crm.objects.deals.highly_sensitive.write.v2 - oauth2: - crm.objects.custom.highly_sensitive.read.v2 - oauth2: - crm.objects.goals.write - oauth2: - crm.objects.projects.sensitive.read - oauth2: - crm.objects.line_items.write - oauth2: - crm.objects.contacts.write - oauth2: - crm.objects.goals.read - oauth2: - crm.objects.line_items.read - oauth2: - crm.objects.partner-clients.write - oauth2: - crm.objects.projects.write - oauth2: - crm.objects.projects.sensitive.write - oauth2: - crm.objects.deals.sensitive.read.v2 - oauth2: - crm.objects.quotes.write - oauth2: - tickets.highly_sensitive.v2 - oauth2: - crm.objects.leads.read - oauth2: - crm.objects.leads.write - oauth2: - crm.objects.carts.read - oauth2: - crm.objects.emails.read - oauth2: - crm.objects.quotes.read - oauth2: - crm.objects.courses.write - oauth2: - crm.objects.partner-clients.read - oauth2: - crm.objects.notes.read - oauth2: - crm.objects.courses.read - oauth2: - crm.objects.listings.read - oauth2: - crm.objects.contacts.sensitive.read.v2 - oauth2: - crm.objects.products.read components: schemas: PublicObjectSearchRequest: required: - after - filterGroups - limit - properties - sorts type: object properties: after: type: string description: >- String que representa o token do cursor de paginação para recuperar o próximo conjunto de resultados. filterGroups: type: array description: >- Uma matriz de grupos de filtros usada para refinar os resultados da pesquisa com base em critérios específicos. items: $ref: '#/components/schemas/FilterGroup' limit: type: integer description: >- Um número inteiro que especifica o número máximo de resultados a serem retornados. format: int32 properties: type: array description: >- Matriz de strings que indica quais propriedades dos objetos devem ser incluídas nos resultados da pesquisa. items: type: string query: type: string description: >- Uma string que representa uma consulta de pesquisa a ser aplicada aos objetos do CRM. sorts: type: array description: >- Matriz de strings que especifica a ordem de classificação dos resultados da pesquisa. items: type: string description: Descreve uma solicitação de pesquisa CollectionResponseWithTotalSimplePublicObject: required: - results - total type: object properties: paging: $ref: '#/components/schemas/Paging' results: type: array description: >- Uma matriz contendo os objetos públicos simples retornados na resposta atual. items: $ref: '#/components/schemas/SimplePublicObject' total: type: integer description: O número de resultados disponíveis format: int32 description: >- Representa uma lista de objetos simples retornados de uma solicitação de API, juntamente com o número total de objetos disponíveis. FilterGroup: required: - filters type: object properties: filters: type: array description: >- Uma matriz de objetos de filtro que especificam as condições a serem aplicadas na consulta de pesquisa. Cada filtro define uma propriedade, um operador e um valor ou intervalo de valores para filtrar. items: $ref: '#/components/schemas/Filter' description: >- Representa um grupo de filtros usados para consultar dados no HubSpot. Este componente é usado para definir critérios de filtragem de registros em vários endpoints de API. Paging: type: object properties: next: $ref: '#/components/schemas/NextPage' prev: $ref: '#/components/schemas/PreviousPage' description: >- Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados. SimplePublicObject: required: - archived - createdAt - id - properties - updatedAt type: object properties: archived: type: boolean description: Um booleano que indica se o objeto está arquivado. archivedAt: type: string description: >- A data e a hora em que este objeto foi arquivado, no formato ISO 8601. format: date-time createdAt: type: string description: A data e a hora em que este objeto foi criado, no formato ISO 8601. format: date-time id: type: string description: >- O identificador exclusivo para este objeto, representado como uma string. objectWriteTraceId: type: string description: >- Uma string usada para rastrear as operações de gravação neste objeto. properties: type: object additionalProperties: type: string description: >- Um objeto que contém pares chave-valor das propriedades do objeto, em que cada chave é um nome de propriedade e cada valor é uma string. propertiesWithHistory: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ValueWithTimestamp' description: >- Um objeto em que cada chave é um nome de propriedade e cada valor é uma matriz de valores históricos com a data/hora, mostrando o histórico de alterações para cada propriedade. updatedAt: type: string description: >- A data e a hora da última atualização deste objeto, no formato ISO 8601. format: date-time url: type: string description: Uma string que representa o URL associado a este objeto. warnings: type: array description: >- Uma matriz de avisos relacionados ao objeto, cada um contendo uma categoria, mensagem e contexto. items: $ref: '#/components/schemas/PublicObjectWarning' description: Um objeto público simples. 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 Filter: required: - operator - propertyName type: object properties: highValue: type: string description: >- Uma string opcional que representa o limite superior de um intervalo ao usar operadores com base em intervalo como "BETWEEN". operator: type: string description: >- O operador usado para comparar a propriedade e o(s) valor(es). É uma string e os valores válidos incluem 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN' e 'NOT_CONTAINS_TOKEN'. enum: - BETWEEN - CONTAINS_TOKEN - EQ - GT - GTE - HAS_PROPERTY - IN - LT - LTE - NEQ - NOT_CONTAINS_TOKEN - NOT_HAS_PROPERTY - NOT_IN propertyName: type: string description: >- O nome da propriedade à qual o filtro é aplicado. É uma string que identifica a propriedade específica de um objeto. value: type: string description: >- O valor usado na condição do filtro. É uma string que representa o valor específico a ser comparado com a propriedade. values: type: array description: >- Uma matriz de strings que representa vários valores para operadores que permitem várias comparações, como "IN" ou "NOT_IN". items: type: string description: >- Define uma única condição para pesquisar objetos do CRM, especificando a propriedade a ser filtrada, o operador a ser usado (como igual a, maior que ou contém) e o(s) valor(es) a ser(em) comparado(s). NextPage: required: - after type: object properties: after: type: string description: >- Um token de string usado como um cursor para indicar o ponto de partida para a próxima página de resultados. link: type: string description: >- Um URL de string que fornece um link direto para a próxima página de resultados. description: >- Especifica as informações de paginação necessárias para recuperar o próximo conjunto de resultados em uma resposta de API paginada PreviousPage: required: - before type: object properties: before: type: string description: >- Um token de string que indica a posição do último item na página anterior. Serve para recuperar o conjunto anterior de resultados em uma lista paginada. link: type: string description: >- Um URL de string que fornece um link direto para acessar a página de resultados anterior. description: >- especifica as informações de paginação necessárias para recuperar o conjunto anterior de resultados em uma resposta de API paginada ValueWithTimestamp: required: - sourceType - timestamp - value type: object properties: sourceId: type: string description: Uma string que identifica a fonte específica do valor. sourceLabel: type: string description: >- Uma string que fornece um rótulo ou descrição para a origem do valor. sourceType: type: string description: Uma string que indica o tipo de origem do valor. timestamp: type: string description: >- A data e a hora em que o registro foi adicionado, no formato ISO 8601. format: date-time updatedByUserId: type: integer description: Número inteiro que representa o ID do usuário que atualizou o valor. format: int32 value: type: string description: >- Uma string que representa o valor associado ao registro de data/hora. description: Modelo de propriedade que inclui data e hora. PublicObjectWarning: required: - category - context - message type: object properties: category: type: string description: Uma string que indica a categoria do aviso. context: type: object additionalProperties: type: string description: >- Um objeto que fornece contexto adicional para o aviso, com propriedades de string. message: type: string description: Uma string contendo a mensagem de aviso. description: >- Representa uma mensagem de aviso relacionada a um objeto público no HubSpot, fornecendo detalhes sobre a natureza e o contexto do aviso. 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: crm.objects.appointments.read: '' crm.objects.appointments.sensitive.read.v2: '' crm.objects.appointments.sensitive.write.v2: '' crm.objects.appointments.write: '' crm.objects.calls.read: '' crm.objects.carts.read: '' crm.objects.carts.write: '' crm.objects.commercepayments.read: '' crm.objects.commercepayments.write: '' crm.objects.companies.highly_sensitive.read.v2: '' crm.objects.companies.highly_sensitive.write.v2: '' crm.objects.companies.read: '' crm.objects.companies.sensitive.read.v2: '' crm.objects.companies.sensitive.write.v2: '' crm.objects.companies.write: '' crm.objects.contacts.highly_sensitive.read.v2: '' crm.objects.contacts.highly_sensitive.write.v2: '' crm.objects.contacts.read: '' crm.objects.contacts.sensitive.read.v2: '' crm.objects.contacts.sensitive.write.v2: '' crm.objects.contacts.write: '' crm.objects.courses.read: '' crm.objects.courses.write: '' crm.objects.custom.highly_sensitive.read.v2: '' crm.objects.custom.highly_sensitive.write.v2: '' crm.objects.custom.read: '' crm.objects.custom.sensitive.read.v2: '' crm.objects.custom.sensitive.write.v2: '' crm.objects.custom.write: '' crm.objects.deals.highly_sensitive.read.v2: '' crm.objects.deals.highly_sensitive.write.v2: '' crm.objects.deals.read: '' crm.objects.deals.sensitive.read.v2: '' crm.objects.deals.sensitive.write.v2: '' crm.objects.deals.write: '' crm.objects.emails.read: '' crm.objects.feedback_submissions.read: '' crm.objects.goals.read: '' crm.objects.goals.write: '' crm.objects.invoices.read: '' crm.objects.invoices.write: '' crm.objects.leads.read: '' crm.objects.leads.write: '' crm.objects.line_items.read: '' crm.objects.line_items.write: '' crm.objects.listings.read: '' crm.objects.listings.write: '' crm.objects.meetings.read: '' crm.objects.notes.read: '' crm.objects.orders.read: '' crm.objects.orders.write: '' crm.objects.partner-clients.read: '' crm.objects.partner-clients.write: '' crm.objects.partner-services.read: '' crm.objects.partner-services.write: '' crm.objects.products.read: '' crm.objects.products.write: '' crm.objects.projects.highly_sensitive.read: '' crm.objects.projects.highly_sensitive.write: '' crm.objects.projects.read: '' crm.objects.projects.sensitive.read: '' crm.objects.projects.sensitive.write: '' crm.objects.projects.write: '' crm.objects.quotes.read: '' crm.objects.quotes.write: '' crm.objects.services.read: '' crm.objects.services.write: '' crm.objects.subscriptions.read: '' crm.objects.subscriptions.write: '' crm.objects.tasks.read: '' crm.objects.tickets.highly_sensitive.read: '' crm.objects.tickets.highly_sensitive.write: '' crm.objects.tickets.sensitive.read: '' crm.objects.tickets.sensitive.write: '' crm.objects.users.read: '' crm.objects.users.write: '' e-commerce: '' media_bridge.read: '' tickets.highly_sensitive.v2: '' tickets.sensitive.v2: '' ````