> ## 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. # Read > Leia um objeto identificado por "{dealId}". "{dealId}" refere-se ao ID interno do objeto por padrão ou, opcionalmente, a qualquer valor de propriedade única conforme especificado pelo parâmetro de consulta "idProperty". Controle o que é retornado pelo parâmetro de consulta "properties". > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/crm-deals-v3.json GET /crm/v3/objects/0-3/{dealId} openapi: 3.0.1 info: title: Negócios description: >- CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application. ## Supported Object Types This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview). |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` | Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body. version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- Quando um representante de vendas começa a trabalhar com um possível cliente, crie um registro de negócio para acompanhar o processo de negociação. Quando o cliente fizer a compra, você pode atualizar o negócio para uma fase de negócio fechado. x-hubspot-related-documentation: - name: Deals Guide url: https://developers.hubspot.com/docs/guides/api/crm/objects/deals x-hubspot-introduction: >- Use a API de negócios para criar e gerenciar registros de CRM que representam transações com contatos e/ou empresas. Os negócios passam pelas fases do pipeline para refletir se a transação foi concluída, está ativa ou foi perdida. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Batch - name: Search paths: /crm/v3/objects/0-3/{dealId}: get: tags: - Basic summary: Ler description: >- Leia um objeto identificado por "{dealId}". "{dealId}" refere-se ao ID interno do objeto por padrão ou, opcionalmente, a qualquer valor de propriedade única conforme especificado pelo parâmetro de consulta "idProperty". Controle o que é retornado pelo parâmetro de consulta "properties". operationId: get-/crm/v3/objects/0-3/{dealId}_getById parameters: - name: dealId in: path required: true schema: pattern: .+ type: string - name: archived in: query description: Se apenas os resultados que foram arquivados devem ser retornados. required: false style: form explode: true schema: type: boolean default: false - name: associations in: query description: >- Uma lista separada por vírgulas de tipos de objeto para recuperar IDs associados. Se alguma das associações especificadas não existir, ela será ignorada. required: false style: form explode: true schema: type: array items: type: string - name: idProperty in: query description: >- O nome de uma propriedade cujos valores são exclusivos para este tipo de objeto required: false style: form explode: true schema: type: string - name: properties in: query description: >- Uma lista separada por vírgulas das propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada. required: false style: form explode: true schema: type: array items: type: string - name: propertiesWithHistory in: query description: >- Uma lista separada por vírgulas das propriedades a serem retornadas junto com seu histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada. required: false style: form explode: true schema: type: array items: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/SimplePublicObjectWithAssociations' default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: SimplePublicObjectWithAssociations: required: - archived - createdAt - id - properties - updatedAt type: object properties: archived: type: boolean description: Se o objeto está arquivado ou não. archivedAt: type: string description: A data e hora em que o objeto foi arquivado, no formato ISO 8601. format: date-time associations: type: object additionalProperties: $ref: '#/components/schemas/CollectionResponseAssociatedId' description: Uma lista que define relacionamentos com outros objetos. createdAt: type: string description: A data e hora em que o objeto foi criado, no formato ISO 8601. format: date-time id: type: string description: O ID exclusivo do objeto. objectWriteTraceId: type: string description: >- Um identificador usado para rastrear a solicitação de criação ou atualização do objeto. properties: type: object additionalProperties: type: string description: Pares de chave-valor que representam as propriedades do objeto. propertiesWithHistory: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ValueWithTimestamp' description: >- Pares de chave-valor que representam as propriedades do objeto junto com seu histórico. updatedAt: type: string description: >- A data e hora em que o objeto foi atualizado pela última vez, no formato ISO 8601. format: date-time url: type: string description: Link do URL para acessar este objeto. warnings: type: array items: $ref: '#/components/schemas/PublicObjectWarning' description: >- Representa um objeto do CRM com suas propriedades, datas e horas, e um conjunto de IDs de objetos associados agrupados por tipo de associação. CollectionResponseAssociatedId: required: - results type: object properties: paging: $ref: '#/components/schemas/Paging' results: type: array description: Uma lista de IDs associados recuperados da solicitação da API. items: $ref: '#/components/schemas/AssociatedId' description: >- Representa uma coleção de IDs associados retornados por uma solicitação de API, incluindo detalhes de paginação para navegar pelos resultados. ValueWithTimestamp: required: - sourceType - timestamp - value type: object properties: sourceId: type: string description: O ID exclusivo da propriedade. sourceLabel: type: string description: Um rótulo legível por humanos. sourceType: type: string description: O tipo de propriedade. timestamp: type: string description: >- A data e hora em que a propriedade foi atualizada, no formato ISO 8601. format: date-time updatedByUserId: type: integer description: O ID do usuário que atualizou a propriedade pela última vez. format: int32 value: type: string description: O valor da propriedade. description: Modelo de propriedade que inclui data e hora. PublicObjectWarning: required: - category - context - message type: object properties: category: type: string description: >- A classificação do aviso, indicando o tipo ou a natureza do problema. context: type: object additionalProperties: type: string description: >- Informações adicionais ou metadados sobre o aviso, fornecendo contexto para entender o problema. message: type: string description: >- O texto da mensagem de aviso, fornecendo informações sobre o problema ou alerta. description: >- Representa uma mensagem de aviso relacionada a um objeto público no HubSpot, fornecendo detalhes sobre a natureza e o contexto do aviso. Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base Paging: type: object properties: next: $ref: '#/components/schemas/NextPage' prev: $ref: '#/components/schemas/PreviousPage' description: >- Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados. AssociatedId: required: - id - type type: object properties: id: type: string description: O ID do tipo de associação. type: type: string description: O tipo de associação. example: deal_to_contact description: Contém o ID e o tipo de uma associação ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. NextPage: required: - after type: object properties: after: type: string description: Um token de cursor de paginação para recuperar páginas subsequentes. link: type: string description: >- Um URL que pode ser usado para recuperar os resultados da próxima página. description: >- Especifica as informações de paginação necessárias para recuperar o próximo conjunto de resultados em uma resposta de API paginada example: after: NTI1Cg%3D%3D link: '?after=NTI1Cg%3D%3D' PreviousPage: required: - before type: object properties: before: type: string description: Um token de cursor de paginação para recuperar páginas anteriores. link: type: string description: >- Um URL que pode ser usado para recuperar os resultados das páginas anteriores. description: >- especifica as informações de paginação necessárias para recuperar o conjunto anterior de resultados em uma resposta de API paginada responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````