> ## 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. # Retrieve List > Recupere uma lista específica pelo nome e ID do tipo de objeto na sua conta HubSpot. Este endpoint permite acessar os detalhes de uma lista, o que pode ser útil para gerenciar e analisar seus dados de CRM. Você também pode optar por incluir filtros na resposta. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/crm-lists-v2026-09.json GET /crm/lists/2026-09/object-type-id/{objectTypeId}/name/{listName} openapi: 3.0.1 info: title: CRM Lists 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: Basic - name: Batch - name: Search paths: /crm/lists/2026-09/object-type-id/{objectTypeId}/name/{listName}: get: tags: - Basic summary: Recuperar lista description: >- Recupere uma lista específica pelo nome e ID do tipo de objeto na sua conta HubSpot. Este endpoint permite acessar os detalhes de uma lista, o que pode ser útil para gerenciar e analisar seus dados de CRM. Você também pode optar por incluir filtros na resposta. operationId: get-/crm/lists/2026-09/object-type-id/{objectTypeId}/name/{listName} parameters: - name: listName in: path description: O nome da lista a ser recuperada. required: true style: simple explode: false schema: type: string - name: objectTypeId in: path description: O identificador exclusivo do tipo de objeto associado à lista. required: true style: simple explode: false schema: type: string - name: includeFilters in: query description: >- Um booleano que indica se os filtros devem ser incluídos na resposta. O padrão é falso. required: false style: form explode: true schema: type: boolean default: false responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ListFetchResponse' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.segments.read - oauth2: - crm.lists.read components: schemas: ListFetchResponse: required: - list type: object properties: list: $ref: '#/components/schemas/PublicObjectList' PublicObjectList: required: - listId - listVersion - name - objectTypeId - processingStatus - processingType type: object properties: createdAt: type: string description: A data e a hora em que a lista foi criada, no formato ISO 8601. format: date-time createdById: type: string description: >- O identificador exclusivo do usuário que criou a lista, representado como uma string. deletedAt: type: string description: A data e hora em que a lista foi excluída, no formato ISO 8601. format: date-time filterBranch: description: >- Um objeto que representa a ramificação de filtro aplicado à lista, que pode ser um de vários tipos de ramificações de filtro. oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filtersUpdatedAt: type: string description: >- Data e hora da última atualização dos filtros da lista, no formato ISO 8601. format: date-time listId: type: string description: O identificador exclusivo da lista, representado como uma string. listPermissions: $ref: '#/components/schemas/PublicListPermissions' listVersion: type: integer description: Um número inteiro que indica a versão da lista. format: int32 membershipSettings: $ref: '#/components/schemas/PublicMembershipSettings' name: type: string description: O nome da lista, representado como uma string. objectTypeId: type: string description: >- O identificador exclusivo para o tipo de objeto associado à lista, representado como uma string. processingStatus: type: string description: Uma string que representa o status de processamento atual da lista. processingType: type: string description: Uma string que indica o tipo de processamento aplicado à lista. size: type: integer description: Um número inteiro que representa o tamanho da lista. format: int64 updatedAt: type: string description: A data e a hora da última atualização da lista, no formato ISO 8601. format: date-time updatedById: type: string description: >- O identificador exclusivo do usuário que atualizou a lista pela última vez, representado como uma string. Error: required: - category - correlationId - message type: object properties: category: type: string description: Uma string que indica a categoria do erro. context: type: object additionalProperties: type: array items: type: string description: >- Um objeto com contexto adicional sobre o erro, representado como um mapa de pares de chave-valor. example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a instância do erro, usado para fins de rastreamento e depuração. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: >- Uma matriz de objetos ErrorDetail, cada um fornecendo informações adicionais sobre erros específicos que ocorreram. items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um objeto com links relacionados, representado como um mapa de nomes de links para URLs. message: type: string description: Uma string que fornece uma descrição legível do erro. example: An error occurred subCategory: type: string description: >- Um objeto que representa uma classificação mais específica do erro dentro de sua categoria. 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 PublicOrFilterBranch: title: OR required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- Uma string que representa o operador usado para combinar os filtros dentro do ramo. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação de filtro, que é "OR" para este componente. default: OR enum: - OR filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, permitindo a combinação de múltiplas condições lógicas dentro da ramificação "OR". items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros individuais que fazem parte do ramo "OR". Cada filtro representa uma condição específica que pode ser avaliada. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicAndFilterBranch: title: AND required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- Uma string que representa o operador usado nesta ramificação de filtro. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação do filtro. O padrão é 'AND'. default: AND enum: - AND filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas. Cada item pode ser uma ramificação de vários tipos, como "OR", "AND", "NOT_ALL", etc. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que se aplicam a esta ramificação. Cada filtro pode ser de vários tipos, como filtros de propriedade, filtros de evento ou filtros de assinatura. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAllFilterBranch: title: NOT_ALL required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Uma string que representa o operador usado no ramo do filtro. filterBranchType: type: string description: >- Uma string que especifica o tipo de ramificação do filtro. O valor padrão é "NOT_ALL". default: NOT_ALL enum: - NOT_ALL filterBranches: type: array description: >- Uma matriz de ramificações de filtro que pode incluir vários tipos, como PublicOrFilterBranch, PublicAndFilterBranch e outros, permitindo uma lógica de filtragem aninhada. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros que pode incluir vários tipos, como PublicPropertyFilter, PublicAssociationInListFilter e outros, usada para aplicar condições específicas aos dados. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAnyFilterBranch: title: NOT_ANY required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Uma string que representa o operador usado no ramo do filtro. filterBranchType: type: string description: >- Uma string que especifica o tipo de ramificação do filtro. O valor padrão é 'NOT_ANY'. default: NOT_ANY enum: - NOT_ANY filterBranches: type: array description: >- Um array de ramificações de filtro que pode incluir vários tipos, como 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', 'PublicNotAnyFilterBranch', 'PublicRestrictedFilterBranch', 'PublicUnifiedEventsFilterBranch' e 'PublicAssociationFilterBranch'. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma série de filtros que podem incluir tipos como 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', 'PublicCtaAnalyticsFilter', 'PublicEventAnalyticsFilter', 'PublicFormSubmissionFilter', 'PublicFormSubmissionOnPageFilter', 'PublicIntegrationEventFilter', 'PublicEmailSubscriptionFilter', 'PublicCommunicationSubscriptionFilter', 'PublicSurveyMonkeyFilter', 'PublicSurveyMonkeyValueFilter', 'PublicWebinarFilter', 'PublicEmailEventFilter', 'PublicPrivacyAnalyticsFilter', 'PublicAdsSearchFilter', 'PublicAdsTimeFilter', 'PublicInListFilter', 'PublicUnifiedEventsFilter' e 'PublicConstantFilter'. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicRestrictedFilterBranch: title: RESTRICTED required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Uma string que representa o operador usado no ramo do filtro. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação do filtro. O valor padrão é 'RESTRICTED'. default: RESTRICTED enum: - RESTRICTED filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, que pode incluir vários tipos, como "PublicOrFilterBranch", "PublicAndFilterBranch" e outros. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros aplicados dentro da ramificação, que pode incluir diferentes tipos de filtro, como "PublicPropertyFilter", "PublicAssociationInListFilter" e outros. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicUnifiedEventsFilterBranch: title: UNIFIED_EVENTS required: - eventTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - operator type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional que pode ser aplicado para agrupar dados de eventos. Pode ser um dos vários tipos de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: Uma string que especifica o ID do tipo de evento filtrado. filterBranchOperator: type: string description: >- Uma string que especifica o operador lógico usado para combinar os filtros e ramificações de filtro dentro desta ramificação. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação do filtro. O valor padrão é 'UNIFIED_EVENTS'. default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, permitindo uma lógica de filtro complexa. Cada item pode ser um dos vários tipos de ramificação de filtro. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros aplicados aos eventos. Cada filtro pode ser um dos vários tipos de filtro predefinidos. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' operator: type: string description: >- Uma string que representa a operação a ser realizada nos eventos. Os valores válidos são 'HAS_COMPLETED' e 'HAS_NOT_COMPLETED'. enum: - HAS_COMPLETED - HAS_NOT_COMPLETED pruningRefineBy: description: >- Um critério de refinamento opcional usado para remover dados de eventos. Pode ser um dos vários tipos de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicAssociationFilterBranch: title: ASSOCIATION required: - associationCategory - associationTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - objectTypeId - operator type: object properties: associationCategory: type: string description: Uma string que categoriza o tipo de associação filtrada. associationTypeId: type: integer description: Um número inteiro que representa o ID do tipo de associação. format: int32 filterBranchOperator: type: string description: >- Uma string que define o operador lógico para combinar filtros dentro desta ramificação. filterBranchType: type: string description: >- Uma string que indica o tipo de ramificação de filtro, que é 'ASSOCIAÇÃO' para este componente. default: ASSOCIATION enum: - ASSOCIATION filterBranches: type: array description: >- Uma matriz de ramificações de filtro aninhadas, permitindo agrupamentos lógicos complexos de filtros. items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array description: >- Uma matriz de filtros aplicados nesta ramificação, cada um definindo critérios específicos para filtrar associações. items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' objectTypeId: type: string description: >- Uma string que representa o ID do tipo de objeto envolvido na associação. operator: type: string description: Uma string que especifica o operador usado na lógica do filtro. x-hubspot-sub-type-impl: true PublicListPermissions: required: - teamsWithEditAccess - usersWithEditAccess type: object properties: teamsWithEditAccess: type: array description: >- Uma matriz de números inteiros que representa os IDs das equipes com acesso de edição à lista. items: type: integer format: int32 usersWithEditAccess: type: array description: >- Uma matriz de números inteiros que representa os IDs dos usuários com acesso de edição à lista. items: type: integer format: int32 PublicMembershipSettings: type: object properties: includeUnassigned: type: boolean description: >- Um booleano que indica se os registros não atribuídos devem ser incluídos nas configurações de participação. membershipTeamId: type: integer description: >- Uma string que representa o identificador exclusivo da equipe associada às configurações de participação. format: int32 ErrorDetail: required: - message type: object properties: code: type: string description: >- Uma string que representa um código de erro específico que identifica o tipo de erro. context: type: object additionalProperties: type: array items: type: string description: >- Um objeto com contexto adicional sobre o erro, representado como um mapa de strings para matrizes de strings, que pode incluir parâmetros ou valores específicos relacionados ao erro. example: '{missingScopes=[scope1, scope2]}' in: type: string description: >- Uma string que indica o local onde o erro ocorreu, como 'query', 'header' ou 'body'. message: type: string description: Uma string contendo uma descrição legível do erro. subCategory: type: string description: >- Um objeto que fornece categorização adicional do erro, que pode conter mais detalhes. 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. PublicPropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: filterType: type: string description: >- O tipo de filtro aplicado. Este é um valor de string que especifica o tipo de operação de filtro. default: PROPERTY enum: - PROPERTY operation: description: >- A operação ou condição específica usada no filtro. Este é um valor de string que define como o filtro deve ser aplicado à propriedade. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' - $ref: '#/components/schemas/PublicComparativeNumberPropertyOperation' property: type: string description: >- O nome da propriedade à qual o filtro é aplicado. Este é um valor de string que representa o nome da propriedade. x-hubspot-sub-type-impl: true PublicAssociationInListFilter: title: ASSOCIATION required: - associationCategory - associationTypeId - coalescingRefineBy - filterType - listId - operator type: object properties: associationCategory: type: string description: >- Uma string que categoriza o tipo de associação, fornecendo contexto adicional para o filtro. associationTypeId: type: integer description: >- Um número inteiro que identifica o tipo específico de associação filtrado. format: int32 coalescingRefineBy: description: >- Um critério de refinamento opcional que pode ser aplicado ao filtro. Pode ser de vários tipos, como PublicNumOccurrencesRefineBy ou PublicRelativeComparativeTimestampRefineBy. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: >- Uma string que especifica o tipo de filtro que está sendo aplicado. O valor padrão é "IN_LIST". default: ASSOCIATION enum: - ASSOCIATION listId: type: string description: >- Uma string que representa o identificador exclusivo da lista à qual o filtro é aplicado. operator: type: string description: >- Uma string que define o operador usado no filtro. Isso determina como os critérios do filtro são aplicados. toObjectType: type: string description: >- Uma string que descreve o tipo de objeto ao qual a associação está relacionada. toObjectTypeId: type: string description: >- Uma string que especifica o ID do tipo de objeto ao qual a associação está relacionada. x-hubspot-sub-type-impl: true PublicPageViewAnalyticsFilter: title: PAGE_VIEW required: - filterType - operator - pageUrl type: object properties: coalescingRefineBy: description: >- Uma propriedade opcional que define o método para refinar o filtro ao agrupar várias condições. Pode ser um dos vários tipos de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' enableTracking: type: boolean description: >- Um valor booleano que indica se o rastreamento está ativado para o filtro de análise de visualização de página. filterType: type: string description: >- Uma string que representa o tipo de filtro aplicado. Esta propriedade determina a categoria do filtro usado na análise. default: PAGE_VIEW enum: - PAGE_VIEW operator: type: string description: >- Uma string que indica o operador usado no filtro, que define como os critérios do filtro são aplicados. pageUrl: type: string description: >- Uma string que representa o URL específico da página a ser rastreada ou analisada. Esta propriedade é usada para filtrar dados de análise com base no URL da página. pruningRefineBy: description: >- Uma propriedade opcional que especifica o método para refinar o filtro por condições de remoção. Pode ser um dos vários tipos de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicCtaAnalyticsFilter: title: CTA required: - ctaName - filterType - operator type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional que pode ser de vários tipos, como número de ocorrências ou refinamentos baseados em tempo. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' ctaName: type: string description: O nome da Call to action filtrada nos dados de análise. filterType: type: string description: Uma string que indica o tipo de filtro aplicado. O padrão é "CTA". default: CTA enum: - CTA operator: type: string description: Uma string que representa a operação a ser realizada pelo filtro. pruningRefineBy: description: >- Um critério de refinamento opcional usado para restringir ainda mais os resultados do filtro, semelhante a coalescingRefineBy. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicEventAnalyticsFilter: title: EVENT required: - eventId - filterType - operator type: object properties: coalescingRefineBy: description: >- Uma propriedade opcional que permite um refinamento adicional dos critérios de filtro usando um método de coalescência. Pode ser um dos vários tipos de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventId: type: string description: >- Uma string que representa o identificador exclusivo do evento a ser filtrado. Esta propriedade é obrigatória. filterType: type: string description: >- Uma string que representa o tipo de filtro aplicado. Esta propriedade é obrigatória. default: EVENT enum: - EVENT operator: type: string description: >- Uma string que especifica o operador usado no filtro. Esta propriedade é obrigatória. pruningRefineBy: description: >- Uma propriedade opcional que permite um refinamento adicional dos critérios de filtro usando um método de remoção. Pode ser um dos vários tipos de refinamento predefinidos. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionFilter: title: FORM_SUBMISSION required: - filterType - operator type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional usado para agrupar envios de formulários com base em condições específicas. Pode ser de vários tipos, semelhante a pruningRefineBy. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: >- Uma string que especifica o tipo de filtro que está sendo aplicado. O valor padrão é 'FORM_SUBMISSION'. default: FORM_SUBMISSION enum: - FORM_SUBMISSION formId: type: string description: >- Uma string que representa o identificador exclusivo do formulário ao qual o filtro se aplica. operator: type: string description: >- Uma string que define a operação a ser realizada pelo filtro. Os valores válidos incluem "FILLED_OUT" e "NOT_FILLED_OUT". enum: - FILLED_OUT - NOT_FILLED_OUT pruningRefineBy: description: >- Um critério de refinamento opcional que especifica ainda mais as condições para a remoção de envios de formulário. Pode ser de vários tipos, como número de ocorrências ou comparações de data/hora. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionOnPageFilter: title: FORM_SUBMISSION_ON_PAGE required: - filterType - operator - pageId type: object properties: coalescingRefineBy: description: >- Um critério de refinamento opcional usado para agrupar resultados com base em condições específicas, semelhante a pruningRefineBy. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: O tipo de filtro aplicado, fixado como 'FORM_SUBMISSION'. default: FORM_SUBMISSION_ON_PAGE enum: - FORM_SUBMISSION_ON_PAGE formId: type: string description: >- Uma string que representa o identificador exclusivo do formulário a ser filtrado. operator: type: string description: >- A operação a ser realizada pelo filtro. É uma string e pode ter valores como "FILLED_OUT" ou "NOT_FILLED_OUT". enum: - FILLED_OUT - NOT_FILLED_OUT pageId: type: string description: >- Uma string que representa o identificador exclusivo da página na qual ocorreu o envio de formulário. pruningRefineBy: description: >- Uma propriedade opcional que permite refinar ainda mais o filtro usando vários critérios, como ocorrências ou intervalos de tempo. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicIntegrationEventFilter: title: INTEGRATION_EVENT required: - eventTypeId - filterLines - filterType type: object properties: eventTypeId: type: integer description: >- Uma string que identifica de forma exclusiva o tipo de evento a ser filtrado. Esta propriedade é obrigatória. format: int32 filterLines: type: array description: >- Uma matriz de linhas de filtro que definem critérios de filtragem adicionais. Cada linha de filtro é um objeto que especifica as condições para filtrar eventos. items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: >- Uma string que representa o tipo de filtro aplicado. Esta propriedade é obrigatória. default: INTEGRATION_EVENT enum: - INTEGRATION_EVENT x-hubspot-sub-type-impl: true PublicEmailSubscriptionFilter: title: EMAIL_SUBSCRIPTION required: - acceptedStatuses - filterType - subscriptionIds type: object properties: acceptedStatuses: type: array description: Uma matriz de strings que indicam os status aceitos para o filtro. items: type: string filterType: type: string description: >- Uma string que indica o tipo de filtro. O valor padrão é 'EMAIL_SUBSCRIPTION'. default: EMAIL_SUBSCRIPTION enum: - EMAIL_SUBSCRIPTION subscriptionIds: type: array description: >- Uma matriz de strings que representam os IDs das assinaturas para filtrar. items: type: string subscriptionType: type: string description: Uma string que representa o tipo de assinatura para filtrar. x-hubspot-sub-type-impl: true PublicCommunicationSubscriptionFilter: title: COMMUNICATION_SUBSCRIPTION required: - acceptedOptStates - channel - filterType - subscriptionIds - subscriptionType type: object properties: acceptedOptStates: type: array description: >- Uma matriz de strings que representa os estados de opt-in aceitos para a assinatura. items: type: string businessUnitId: type: string description: >- Uma string que representa o ID da unidade de negócio associada à assinatura. channel: type: string description: Uma string que indica o canal de comunicação para a assinatura. filterType: type: string description: >- Uma string que representa o tipo de filtro. O padrão é "COMMUNICATION_SUBSCRIPTION". default: COMMUNICATION_SUBSCRIPTION enum: - COMMUNICATION_SUBSCRIPTION subscriptionIds: type: array description: >- Uma matriz de strings que representam os IDs das assinaturas a serem filtradas. items: type: string subscriptionType: type: string description: Uma string que indica o tipo de assinatura que está sendo filtrada. x-hubspot-sub-type-impl: true PublicSurveyMonkeyFilter: title: SURVEY_MONKEY required: - filterType - operator - surveyId type: object properties: filterType: type: string description: >- Uma string que representa o tipo de filtro. O valor padrão é 'SURVEY_MONKEY_VALUE'. default: SURVEY_MONKEY enum: - SURVEY_MONKEY operator: type: string description: Uma string que especifica a operação a ser realizada para o filtro. surveyId: type: string description: >- Uma string que identifica exclusivamente a pesquisa da qual os dados são filtrados. x-hubspot-sub-type-impl: true PublicSurveyMonkeyValueFilter: title: SURVEY_MONKEY_VALUE required: - filterType - operator - surveyId - surveyQuestion - valueComparison type: object properties: filterType: type: string description: >- Uma string que especifica o tipo de filtro que está sendo aplicado. O valor padrão é 'SURVEY_MONKEY_VALUE'. default: SURVEY_MONKEY_VALUE enum: - SURVEY_MONKEY_VALUE operator: type: string description: >- Uma string que especifica o operador usado no filtro, determinando como os dados da pesquisa devem ser avaliados em relação aos critérios especificados. surveyAnswerColId: type: string description: >- Uma string que representa o identificador da coluna para a resposta da pesquisa que está sendo filtrada. surveyAnswerRowId: type: string description: >- Uma string que representa o identificador da linha para a resposta da pesquisa que está sendo filtrada. surveyId: type: string description: >- Uma string que representa o identificador exclusivo da pesquisa do SurveyMonkey. surveyQuestion: type: string description: >- Uma string que indica a pergunta específica da pesquisa à qual o filtro se destina. valueComparison: description: >- Um objeto que define a operação para comparar valores, que pode ser um de vários tipos, como operações booleanas, numéricas, de string, de data ou de enumeração. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' - $ref: '#/components/schemas/PublicComparativeNumberPropertyOperation' x-hubspot-sub-type-impl: true PublicWebinarFilter: title: WEBINAR required: - filterType - operator type: object properties: filterType: type: string description: >- Uma string que especifica o tipo de filtro que está sendo aplicado. O valor padrão é 'WEBINAR'. default: WEBINAR enum: - WEBINAR operator: type: string description: Uma string que define a operação ou condição aplicada pelo filtro. webinarId: type: string description: >- Uma string que representa o identificador exclusivo do webinar ao qual o filtro é aplicado. x-hubspot-sub-type-impl: true PublicEmailEventFilter: title: EMAIL_EVENT required: - appId - emailId - filterType - level - operator type: object properties: appId: type: string description: >- Uma string que representa o ID do aplicativo associado ao evento de e-mail. clickUrl: type: string description: Uma string que representa o URL clicado no evento de e-mail. emailId: type: string description: >- Uma string que representa o identificador exclusivo do e-mail associado ao evento. filterType: type: string description: >- Uma string que representa o tipo de filtro aplicado. Esta propriedade é obrigatória. default: EMAIL_EVENT enum: - EMAIL_EVENT level: type: string description: Uma string que indica o nível do filtro de evento de e-mail. operator: type: string description: Uma string que especifica o operador usado na condição do filtro. enum: - BOUNCED - LINK_CLICKED - MARKED_SPAM - OPENED - OPENED_BUT_LINK_NOT_CLICKED - OPENED_BUT_NOT_REPLIED - RECEIVED - RECEIVED_BUT_NOT_OPENED - REPLIED - SENT - SENT_BUT_LINK_NOT_CLICKED - SENT_BUT_NOT_RECEIVED - UNSUBSCRIBED pruningRefineBy: description: >- Um objeto que fornece critérios adicionais para refinar o filtro. Pode ser de vários tipos, como PublicNumOccurrencesRefineBy, PublicSetOccurrencesRefineBy, etc. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicPrivacyAnalyticsFilter: title: PRIVACY required: - filterType - operator - privacyName type: object properties: filterType: type: string description: >- Uma string que representa o tipo de filtro. O valor padrão é 'PRIVACY_ANALYTICS'. default: PRIVACY enum: - PRIVACY operator: type: string description: Uma string que define o operador usado na condição do filtro. privacyName: type: string description: >- Uma string que especifica o nome da configuração de privacidade filtrada. x-hubspot-sub-type-impl: true PublicAdsSearchFilter: title: ADS_SEARCH required: - adNetwork - entityType - filterType - operator - searchTermType - searchTerms type: object properties: adNetwork: type: string description: >- A rede de anúncios segmentada pelo filtro. Este é um valor de string que indica a rede de anúncios. entityType: type: string description: >- O tipo de entidade ao qual o filtro é aplicado. Este é um valor de string que representa o tipo de entidade. filterType: type: string description: >- O tipo de filtro que está sendo aplicado. Este é um valor de string que define a categoria ou natureza do filtro. default: ADS_SEARCH enum: - ADS_SEARCH operator: type: string description: >- O operador usado para aplicar o filtro. Este é um valor de string que especifica a operação lógica para o filtro. searchTermType: type: string description: >- Tipo de termo de pesquisa usado no filtro. Este é um valor de string que especifica como o termo de pesquisa é interpretado. searchTerms: type: array description: >- Uma matriz de strings que representa os termos de pesquisa usados no filtro. items: type: string x-hubspot-sub-type-impl: true PublicAdsTimeFilter: title: ADS_TIME required: - filterType - pruningRefineBy type: object properties: filterType: type: string description: >- Uma string que representa o tipo de filtro que está sendo aplicado. O valor padrão é 'ADS_TIME'. default: ADS_TIME enum: - ADS_TIME pruningRefineBy: description: >- Uma propriedade opcional que permite um refinamento adicional dos critérios de filtro com base no tempo. Pode ser de vários tipos, como comparações de tempo relativas ou absolutas. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicInListFilter: title: IN_LIST required: - filterType - listId - operator type: object properties: filterType: type: string description: Uma string que indica o tipo de filtro. O padrão é 'IN_LIST'. default: IN_LIST enum: - IN_LIST listId: type: string description: >- O identificador exclusivo da lista para verificar a participação, representado como uma string. metadata: $ref: '#/components/schemas/PublicInListFilterMetadata' operator: type: string description: Uma string que representa o operador usado no filtro. x-hubspot-sub-type-impl: true PublicUnifiedEventsFilter: title: UNIFIED_EVENTS required: - filterLines - filterType type: object properties: coalescingRefineBy: description: >- Uma condição de refinamento opcional usada para agrupar eventos com base em critérios específicos, como número de ocorrências ou período de tempo. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: >- Uma string que representa o identificador exclusivo para o tipo de evento que está sendo filtrado. filterLines: type: array description: >- Uma matriz de filtros que são aplicados aos eventos. Cada filtro especifica critérios adicionais para refinar os dados do evento. items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: >- Uma string que especifica o tipo de filtro, com valor padrão 'UNIFIED_EVENTS'. default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS pruningRefineBy: description: >- Uma condição de refinamento opcional usada para remover os eventos com base em critérios específicos, como número de ocorrências ou período. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicConstantFilter: title: CONSTANT required: - filterType - shouldAccept type: object properties: filterType: type: string description: >- Uma string que especifica o tipo de filtro. Para este componente, é um valor constante que indica a natureza do filtro. default: CONSTANT enum: - CONSTANT shouldAccept: type: boolean description: >- Um booleano que indica se a condição do filtro deve ser aceita ou não. source: type: string description: >- Uma string que representa a origem ou o contexto do filtro, fornecendo informações adicionais sobre onde ou como o filtro é aplicado. x-hubspot-sub-type-impl: true PublicNumOccurrencesRefineBy: title: NUM_OCCURRENCES required: - type type: object properties: maxOccurrences: type: integer description: >- Um número inteiro que especifica o número máximo de ocorrências permitidas. format: int32 minOccurrences: type: integer description: >- Um número inteiro que especifica o número mínimo de ocorrências necessárias. format: int32 type: type: string description: >- Uma string que indica o tipo de refinamento, que é 'NUM_OCCURRENCES' por padrão. default: NUM_OCCURRENCES enum: - NUM_OCCURRENCES x-hubspot-sub-type-impl: true PublicSetOccurrencesRefineBy: title: SET_OCCURRENCES required: - setType - type type: object properties: setType: type: string description: >- Uma string que especifica o tipo de conjunto usado para o refinamento. type: type: string description: >- Uma string que indica o tipo de refinamento, que é "SET_OCCURRENCES". default: SET_OCCURRENCES enum: - SET_OCCURRENCES x-hubspot-sub-type-impl: true PublicRelativeComparativeTimestampRefineBy: title: RELATIVE_COMPARATIVE required: - comparison - timeOffset - type type: object properties: comparison: type: string description: >- Uma string que define a operação de comparação a ser usada no refinamento. timeOffset: $ref: '#/components/schemas/PublicTimeOffset' type: type: string description: >- Uma string que especifica o tipo de refinamento, com o valor padrão 'RELATIVE_COMPARATIVE'. default: RELATIVE_COMPARATIVE enum: - RELATIVE_COMPARATIVE x-hubspot-sub-type-impl: true PublicRelativeRangedTimestampRefineBy: title: RELATIVE_RANGED required: - lowerBoundOffset - rangeType - type - upperBoundOffset type: object properties: lowerBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' rangeType: type: string description: Uma string que especifica o tipo de intervalo aplicado. type: type: string description: >- Uma string que indica o tipo de refinamento, com um valor padrão de "RELATIVE_RANGED". default: RELATIVE_RANGED enum: - RELATIVE_RANGED upperBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' x-hubspot-sub-type-impl: true PublicAbsoluteComparativeTimestampRefineBy: title: ABSOLUTE_COMPARATIVE required: - comparison - timestamp - type type: object properties: comparison: type: string description: >- Uma string que representa a operação de comparação a ser realizada com data/hora. timestamp: type: integer description: >- Um número inteiro que representa data/hora específica a ser usado na comparação, geralmente expresso como um data/hora Unix em milissegundos. format: int64 type: type: string description: >- Uma string que representa o tipo de refinamento, que é 'ABSOLUTE_COMPARATIVE' por padrão. default: ABSOLUTE_COMPARATIVE enum: - ABSOLUTE_COMPARATIVE x-hubspot-sub-type-impl: true PublicAbsoluteRangedTimestampRefineBy: title: ABSOLUTE_RANGED required: - lowerTimestamp - rangeType - type - upperTimestamp type: object properties: lowerTimestamp: type: integer description: >- Um número inteiro que representa o limite inferior do intervalo de data/hora, no formato de tempo Unix (milissegundos). format: int64 rangeType: type: string description: Uma string que especifica o tipo de intervalo usado no filtro. type: type: string description: >- Uma string que indica o tipo de operação de refinamento, que é "ABSOLUTE_RANGED". default: ABSOLUTE_RANGED enum: - ABSOLUTE_RANGED upperTimestamp: type: integer description: >- Um número inteiro que representa o limite superior do intervalo de data/hora, no formato de tempo Unix (milissegundos). format: int64 x-hubspot-sub-type-impl: true PublicAllHistoryRefineBy: title: ALL_HISTORY required: - type type: object properties: type: type: string description: >- Uma string que especifica o tipo de refinamento, com um valor padrão de 'ALL_HISTORY'. default: ALL_HISTORY enum: - ALL_HISTORY x-hubspot-sub-type-impl: true PublicTimePointOperation: title: TIME_POINT required: - includeObjectsWithNoValueSet - operationType - operator - timePoint - type type: object properties: endpointBehavior: type: string description: >- Uma string que descreve o comportamento do endpoint no contexto da operação de ponto no tempo. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm valor definido para o ponto no tempo. operationType: type: string description: >- Uma string que indica o tipo de operação, que é 'TIME_POINT' por padrão. default: TIME_POINT enum: - TIME_POINT operator: type: string description: >- Uma string que representa o operador usado na operação de ponto no tempo. propertyParser: type: string description: >- Uma string que representa o analisador usado para a propriedade na operação de ponto no tempo. timePoint: description: >- Um objeto que representa o ponto no tempo específico usado na operação. Pode ser de vários tipos, como um ponto de data, ponto de tempo indexado ou tempo referenciado por propriedade. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' type: type: string description: >- Uma string que indica o tipo específico da operação de ponto no tempo. x-hubspot-sub-type-impl: true PublicRangedTimeOperation: title: TIME_RANGED required: - includeObjectsWithNoValueSet - lowerBoundTimePoint - operationType - operator - type - upperBoundTimePoint type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. lowerBoundEndpointBehavior: type: string description: >- Uma string que especifica o comportamento do ponto final do limite inferior no intervalo de tempo. lowerBoundTimePoint: description: >- Um objeto que representa o ponto de tempo do limite inferior do intervalo, que pode ser um ponto de data, um ponto de tempo indexado ou um tempo referenciado por propriedade. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' operationType: type: string description: >- Uma string que indica o tipo de operação, que está relacionada a operações de intervalo de tempo. operator: type: string description: >- Uma string que representa o operador usado na operação de intervalo de tempo. propertyParser: type: string description: Uma string que define o analisador de propriedade usado na operação. type: type: string description: Uma string que indica o tipo de operação, que é 'TIME_RANGED'. default: TIME_RANGED enum: - TIME_RANGED upperBoundEndpointBehavior: type: string description: >- Uma string que especifica o comportamento do ponto final do limite superior no intervalo de tempo. upperBoundTimePoint: description: >- Um objeto que representa o ponto de tempo do limite superior do intervalo, que pode ser um ponto de data, um ponto de tempo indexado ou um tempo referenciado por propriedade. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' x-hubspot-sub-type-impl: true PublicBoolPropertyOperation: title: BOOL required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: >- Uma string que indica o tipo de operação. O valor padrão é 'BOOLEAN'. default: BOOL enum: - BOOL operator: type: string description: Uma string que representa o operador usado na operação. value: type: boolean description: Um booleano que representa o valor a ser usado na operação. x-hubspot-sub-type-impl: true PublicNumberPropertyOperation: title: NUMBER required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido para a propriedade. operationType: type: string description: Uma string que indica o tipo de operação. O valor padrão é 'NUMBER'. default: NUMBER enum: - NUMBER operator: type: string description: Uma string que representa o operador usado na operação. value: type: number description: Um número que representa o valor envolvido na operação. x-hubspot-sub-type-impl: true PublicStringPropertyOperation: title: STRING required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. operationType: type: string description: Uma string que indica o tipo de operação. O valor padrão é 'STRING'. default: STRING enum: - STRING operator: type: string description: Uma string que representa o operador usado na operação. value: type: string description: Uma string que representa o valor envolvido na operação. x-hubspot-sub-type-impl: true PublicDateTimePropertyOperation: title: DATETIME required: - includeObjectsWithNoValueSet - operationType - operator - requiresTimeZoneConversion - timestamp type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. operationType: type: string description: >- Uma string que representa o tipo de operação realizada. O valor padrão é "DATE_TIME". default: DATETIME enum: - DATETIME operator: type: string description: Uma string que especifica o operador usado na operação. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação requer conversão com base em fusos horários. timestamp: type: integer description: >- Um número inteiro que representa um timestamp Unix em milissegundos, usado como ponto de referência para a operação. format: int64 x-hubspot-sub-type-impl: true PublicRangedDatePropertyOperation: title: RANGED_DATE required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - requiresTimeZoneConversion - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido para a propriedade. lowerBound: type: integer description: >- Um número inteiro que representa o limite inferior do intervalo de datas, formatado como um int64. format: int64 operationType: type: string description: >- Uma string que indica o tipo de operação, que é "RANGED_DATE" por padrão. default: RANGED_DATE enum: - RANGED_DATE operator: type: string description: Uma string que representa o operador usado na operação. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação exige conversão de fuso horário. upperBound: type: integer description: >- Um número inteiro que representa o limite superior do intervalo de datas, formatado como um int64. format: int64 x-hubspot-sub-type-impl: true PublicComparativePropertyUpdatedOperation: title: COMPARATIVE_PROPERTY_UPDATED required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: Uma string que especifica o nome da propriedade a ser comparada. defaultComparisonValue: type: string description: >- Uma string que representa o valor padrão a ser usado na comparação, caso nenhum outro valor seja definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: >- Uma string que indica o tipo de operação. O padrão é "COMPARATIVE_STRING". default: COMPARATIVE_PROPERTY_UPDATED enum: - COMPARATIVE_PROPERTY_UPDATED operator: type: string description: Uma string que representa o operador usado na comparação. x-hubspot-sub-type-impl: true PublicComparativeDatePropertyOperation: title: COMPARATIVE_DATE required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: >- Uma string que especifica o nome da propriedade a ser usada para comparação. defaultComparisonValue: type: string description: >- Uma string que representa o valor padrão a ser usado na comparação se nenhum valor específico for definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido para a propriedade comparada. operationType: type: string description: >- Uma string que indica o tipo de operação, com um valor padrão de "COMPARATIVE_DATE". default: COMPARATIVE_DATE enum: - COMPARATIVE_DATE operator: type: string description: Uma string que representa o operador usado na comparação. x-hubspot-sub-type-impl: true PublicRollingDateRangePropertyOperation: title: ROLLING_DATE_RANGE required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - requiresTimeZoneConversion type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido para a propriedade filtrada. numberOfDays: type: integer description: >- Um número inteiro que especifica o número de dias para o período de dias corridos. format: int32 operationType: type: string description: >- Uma string que indica o tipo de operação, que é 'ROLLING_DATE_RANGE' por padrão. default: ROLLING_DATE_RANGE enum: - ROLLING_DATE_RANGE operator: type: string description: Uma string que representa o operador usado na operação de filtro. requiresTimeZoneConversion: type: boolean description: >- Um booleano que indica se a operação exige conversão de fuso horário. x-hubspot-sub-type-impl: true PublicRollingPropertyUpdatedOperation: title: ROLLING_PROPERTY_UPDATED required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. numberOfDays: type: integer description: >- Um número inteiro que especifica o número de dias durante os quais a operação contínua é aplicada. format: int32 operationType: type: string description: >- Uma string que indica o tipo de operação, com valor padrão 'ROLLING_PROPERTY_UPDATED'. default: ROLLING_PROPERTY_UPDATED enum: - ROLLING_PROPERTY_UPDATED operator: type: string description: Uma string que representa o operador usado na operação. x-hubspot-sub-type-impl: true PublicEnumerationPropertyOperation: title: ENUMERATION required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: >- Uma string que indica o tipo de operação, com um valor padrão de "ENUMERATION". default: ENUMERATION enum: - ENUMERATION operator: type: string description: >- Uma string que representa o operador usado na operação de enumeração. values: type: array description: >- Uma matriz de strings que representa os valores de enumeração envolvidos na operação. items: type: string x-hubspot-sub-type-impl: true PublicAllPropertyTypesOperation: title: ALL_PROPERTY required: - includeObjectsWithNoValueSet - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem um valor definido para a propriedade devem ser incluídos na operação. Esta propriedade é obrigatória. operationType: type: string description: >- Uma string que indica o tipo de operação realizada. Esta propriedade é obrigatória. default: ALL_PROPERTY enum: - ALL_PROPERTY operator: type: string description: >- Uma string que representa o operador usado na operação de filtro. Esta propriedade é obrigatória. x-hubspot-sub-type-impl: true PublicRangedNumberPropertyOperation: title: NUMBER_RANGED required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser definidos para a propriedade. lowerBound: type: integer description: Número inteiro que especifica o limite inferior do intervalo. format: int64 operationType: type: string description: >- Uma string que indica o tipo de operação, que é "RANGED_NUMBER" por padrão. default: NUMBER_RANGED enum: - NUMBER_RANGED operator: type: string description: Uma string que representa o operador usado na operação. upperBound: type: integer description: Número inteiro que especifica o limite superior do intervalo. format: int64 x-hubspot-sub-type-impl: true PublicMultiStringPropertyOperation: title: MULTISTRING required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se objetos sem valor definido devem ser incluídos na operação. operationType: type: string description: >- Uma string que indica o tipo de operação. O valor padrão é 'MULTI_STRING'. default: MULTISTRING enum: - MULTISTRING operator: type: string description: Uma string que representa o operador usado na operação. values: type: array description: >- Uma matriz de strings que representa os valores envolvidos na operação. items: type: string x-hubspot-sub-type-impl: true PublicDatePropertyOperation: title: DATE required: - day - includeObjectsWithNoValueSet - month - operationType - operator - year type: object properties: day: type: integer description: Um número inteiro que representa o componente de dia da data. format: int32 includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm um valor definido para a propriedade de data. month: type: string description: Um número inteiro que representa o componente de mês da data. operationType: type: string description: >- Uma string que indica o tipo de operação, especificamente para propriedades de data. default: DATE enum: - DATE operator: type: string description: Uma string que representa o operador usado na operação de data. year: type: integer description: Um número inteiro que representa o componente do ano da data. format: int32 x-hubspot-sub-type-impl: true PublicCalendarDatePropertyOperation: title: CALENDAR_DATE required: - includeObjectsWithNoValueSet - operationType - operator - timeUnit type: object properties: fiscalYearStart: type: string description: >- Uma string que indica o início do ano fiscal, usada se a operação envolver cálculos de ano fiscal. enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm valor definido para a propriedade de data do calendário. operationType: type: string description: >- Uma string que indica o tipo de operação. O valor padrão é 'CALENDAR_DATE'. default: CALENDAR_DATE enum: - CALENDAR_DATE operator: type: string description: Uma string que representa o operador usado na operação. timeUnit: type: string description: >- Uma string que representa a unidade de tempo usada na operação, como "DAY", "WEEK", "MONTH" ou "YEAR". timeUnitCount: type: integer description: >- Um número inteiro que representa a contagem das unidades de tempo envolvidas na operação. format: int32 useFiscalYear: type: boolean description: Um booleano que indica se o ano fiscal será usado na operação. x-hubspot-sub-type-impl: true PublicComparativeStringPropertyOperation: title: COMPARATIVE_STRING required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: Uma string que especifica o nome da propriedade a ser comparada. defaultComparisonValue: type: string description: >- Uma string que representa o valor padrão a ser usado na comparação se o valor da propriedade não estiver definido. includeObjectsWithNoValueSet: type: boolean description: >- Um booleano que indica se devem ser incluídos objetos que não têm valor definido para a propriedade que está sendo comparada. operationType: type: string description: >- Uma string que indica o tipo de operação. O padrão é "COMPARATIVE_STRING". default: COMPARATIVE_STRING enum: - COMPARATIVE_STRING operator: type: string description: Uma string que representa o operador usado na comparação. x-hubspot-sub-type-impl: true PublicComparativeNumberPropertyOperation: title: COMPARATIVE_NUMBER required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string defaultComparisonValue: type: string includeObjectsWithNoValueSet: type: boolean operationType: type: string default: COMPARATIVE_NUMBER enum: - COMPARATIVE_NUMBER operator: type: string x-hubspot-sub-type-impl: true PublicEventFilterMetadata: required: - operation - property type: object properties: operation: description: >- Define a operação a ser aplicada à propriedade para filtragem. É um valor de string. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' - $ref: '#/components/schemas/PublicComparativeNumberPropertyOperation' property: type: string description: >- Representa a propriedade específica do evento que o filtro está segmentando. É um valor de string. PublicInListFilterMetadata: required: - id - inListType type: object properties: id: type: string description: >- Uma string que representa o identificador exclusivo para os metadados do filtro. inListType: type: string description: Uma string que indica o tipo de lista ao qual o filtro se aplica. PublicTimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer description: >- Um número inteiro que especifica o valor das unidades de tempo para deslocamento. format: int64 offsetDirection: type: string description: >- Uma string que indica a direção do deslocamento de tempo. Os valores válidos são "BEFORE" e "AFTER". timeUnit: type: string description: >- Uma string que representa a unidade de tempo para o deslocamento. Os valores válidos incluem "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER" e "YEAR". PublicDatePoint: title: DATE required: - day - month - timeType - year - zoneId type: object properties: day: type: integer description: Um número inteiro que representa o componente de dia da data. format: int32 hour: type: integer description: Um número inteiro que representa o componente de hora. format: int32 millisecond: type: integer description: >- Um número inteiro que representa o componente de milissegundos do tempo. format: int32 minute: type: integer description: Um número inteiro que representa o componente de minuto do horário. format: int32 month: type: integer description: Um número inteiro que representa o componente de mês da data. format: int32 second: type: integer description: Um número inteiro que representa o componente de segundo do horário. format: int32 timeType: type: string description: >- Uma string que indica o tipo de referência de tempo, geralmente definida como "DATE". default: DATE enum: - DATE timezoneSource: type: string description: Uma string que representa a origem das informações do fuso horário. year: type: integer description: Um número inteiro que representa o componente do ano da data. format: int32 zoneId: type: string description: Uma string que especifica o identificador do fuso horário. x-hubspot-sub-type-impl: true PublicIndexedTimePoint: title: INDEXED required: - indexReference - timeType - zoneId type: object properties: indexReference: description: >- Um objeto que define o ponto de referência para o tempo indexado, que pode ser uma das várias referências predefinidas como "agora", "hoje" ou um período fiscal específico. oneOf: - $ref: '#/components/schemas/PublicNowReference' - $ref: '#/components/schemas/PublicTodayReference' - $ref: '#/components/schemas/PublicWeekReference' - $ref: '#/components/schemas/PublicFiscalQuarterReference' - $ref: '#/components/schemas/PublicFiscalYearReference' - $ref: '#/components/schemas/PublicYearReference' - $ref: '#/components/schemas/PublicQuarterReference' - $ref: '#/components/schemas/PublicMonthReference' offset: $ref: '#/components/schemas/PublicIndexOffset' timeType: type: string description: >- Uma string que indica o tipo de ponto no tempo, com um valor padrão de "INDEXED". default: INDEXED enum: - INDEXED timezoneSource: type: string description: Uma string que representa a origem das informações do fuso horário. zoneId: type: string description: Uma string que especifica o ID do fuso horário. x-hubspot-sub-type-impl: true PublicPropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - zoneId type: object properties: property: type: string description: >- Uma string que representa a propriedade usada para referenciar o tempo. referenceType: type: string description: >- Uma string que indica o tipo de referência, com um valor padrão de "PROPERTY_REFERENCE". timeType: type: string description: >- Uma string que indica o tipo de referência de tempo. O padrão é 'PROPERTY_REFERENCE'. default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: Uma string que representa a origem das informações do fuso horário. zoneId: type: string description: Uma string que especifica o ID do fuso horário. x-hubspot-sub-type-impl: true PublicNowReference: title: NOW required: - referenceType type: object properties: hour: type: integer description: Um número inteiro que representa a hora atual. format: int32 millisecond: type: integer description: >- Um número inteiro que representa a parte dos milissegundos da hora atual. format: int32 minute: type: integer description: Um número inteiro que representa a parte dos minutos da hora atual. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência. O valor padrão é "NOW" e é usado para especificar que a referência é para a hora atual. default: NOW enum: - NOW second: type: integer description: Um número inteiro que representa a parte dos segundos da hora atual. format: int32 x-hubspot-sub-type-impl: true PublicTodayReference: title: TODAY required: - referenceType type: object properties: hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é "TODAY" por padrão. default: TODAY enum: - TODAY second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicWeekReference: title: WEEK required: - dayOfWeek - referenceType type: object properties: dayOfWeek: type: string description: Um número inteiro que representa o dia da semana. enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa o milissegundo do segundo. format: int32 minute: type: integer description: Um número inteiro que representa o minuto da hora. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é 'WEEK' para este componente. default: WEEK enum: - WEEK second: type: integer description: Um número inteiro que representa o segundo do minuto. format: int32 x-hubspot-sub-type-impl: true PublicFiscalQuarterReference: title: FISCAL_QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês do ano. format: int32 referenceType: type: string description: Uma string que indica o tipo de referência, que é "FISCAL_QUARTER". default: FISCAL_QUARTER enum: - FISCAL_QUARTER second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicFiscalYearReference: title: FISCAL_YEAR required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês do ano fiscal. format: int32 referenceType: type: string description: Uma string que indica o tipo de referência, que é 'FISCAL_YEAR'. default: FISCAL_YEAR enum: - FISCAL_YEAR second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicYearReference: title: YEAR required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês do ano. format: int32 referenceType: type: string description: >- Uma string que especifica o tipo de referência, que é 'YEAR' por padrão. default: YEAR enum: - YEAR second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicQuarterReference: title: QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 month: type: integer description: Um número inteiro que representa o mês do ano. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, que é 'QUARTER' para este componente. default: QUARTER enum: - QUARTER second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicMonthReference: title: MONTH required: - day - referenceType type: object properties: day: type: integer description: Um número inteiro que representa o dia do mês. format: int32 hour: type: integer description: Um número inteiro que representa a hora do dia. format: int32 millisecond: type: integer description: Um número inteiro que representa os milissegundos dentro do segundo. format: int32 minute: type: integer description: Um número inteiro que representa os minutos dentro da hora. format: int32 referenceType: type: string description: >- Uma string que indica o tipo de referência, com um valor padrão de "MONTH". default: MONTH enum: - MONTH second: type: integer description: Um número inteiro que representa os segundos dentro do minuto. format: int32 x-hubspot-sub-type-impl: true PublicIndexOffset: type: object properties: days: type: integer description: >- Um número inteiro que representa o número de dias para o deslocamento. format: int32 hours: type: integer description: >- Um número inteiro que representa o número de horas para o deslocamento. format: int32 milliseconds: type: integer description: >- Um número inteiro que representa o número de milissegundos para o deslocamento. format: int32 minutes: type: integer description: >- Um número inteiro que representa o número de minutos para o deslocamento. format: int32 months: type: integer description: >- Um número inteiro que representa o número de meses para o deslocamento. format: int32 quarters: type: integer description: Um número inteiro que representa o deslocamento em trimestres. format: int32 seconds: type: integer description: >- Um número inteiro que representa o número de segundos para o deslocamento. format: int32 weeks: type: integer description: Um número inteiro que representa o deslocamento em semanas. format: int32 years: type: integer description: >- Um número inteiro que representa o número de anos para o deslocamento. format: int32 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: '' ````