> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get a deal
> Returns the deal corresponding to the ID.
`deals:read`
## OpenAPI
````yaml /en/api-reference/openapi.json get /v1/deals/{id}
openapi: 3.1.0
info:
title: OAuth 2.1
description: Endpoints for registering applications and managing OAuth 2.1 tokens.
version: 1.0.0
contact:
name: Vendaze Support
email: suporte@vendaze.com
servers:
- url: https://api.vendaze.com
description: Production
security:
- bearerAuth: []
tags:
- name: OAuth
- name: People
- name: Companies
- name: Deals
- name: Pipelines
- name: Tasks
- name: Task Types
- name: Products
- name: Tags
- name: Lists
- name: Custom Fields
- name: Webhooks
paths:
/v1/deals/{id}:
get:
tags:
- Deals
summary: Get a deal
description: |-
Returns the deal corresponding to the ID.
`deals:read`
operationId: getDeal
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: Deal returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/DealWithEmbeddedResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/InsufficientScope'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalError'
components:
parameters:
id:
name: id
in: path
required: true
schema:
type: string
format: uuid
description: UUID of the resource.
schemas:
DealWithEmbeddedResponse:
type: object
properties:
data:
$ref: '#/components/schemas/DealWithEmbedded'
DealWithEmbedded:
allOf:
- $ref: '#/components/schemas/Deal'
- type: object
properties:
products:
type: array
items:
$ref: '#/components/schemas/DealProduct'
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldValue'
tags:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
color_text:
type: string
nullable: true
color_background:
type: string
nullable: true
people:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
full_name:
type: string
emails:
type: array
nullable: true
items:
type: object
properties:
email:
type: string
type:
type: string
phones:
type: array
nullable: true
items:
type: object
properties:
phone:
type: string
type:
type: string
avatar_url:
type: string
nullable: true
entity_id:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
companies:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
full_name:
type: string
emails:
type: array
nullable: true
items:
type: object
properties:
email:
type: string
type:
type: string
phones:
type: array
nullable: true
items:
type: object
properties:
phone:
type: string
type:
type: string
avatar_url:
type: string
nullable: true
entity_id:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
request_id:
type: string
format: uuid
Deal:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
example: Acme Corp Annual Contract
amount:
type: integer
example: 250000
currency:
$ref: '#/components/schemas/CurrencyCode'
formatted_amount:
type: string
nullable: true
example: R$ 2.500,00
pipeline:
type: object
nullable: true
properties:
id:
type: string
format: uuid
name:
type: string
stage:
type: object
nullable: true
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
enum:
- open
- win
- lost
owner:
$ref: '#/components/schemas/Owner'
source:
type: string
example: My Integration App
forecast_date:
type: string
format: date-time
nullable: true
entity_id:
type: string
example: NEG-0001
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
DealProduct:
type: object
properties:
id:
type: string
format: uuid
product_id:
type: string
format: uuid
nullable: true
name:
type: string
nullable: true
quantity:
type: integer
example: 2
billing_cycle:
type: string
enum:
- one_time
- monthly
- quarterly
- annually
unit_price_cts:
type: integer
description: Unit price in cents.
example: 50000
total_price_cts:
type: integer
description: Total price in cents.
example: 100000
CustomFieldValue:
type: object
properties:
id:
type: string
format: uuid
value: {}
field:
type: object
properties:
id:
type: string
format: uuid
label:
type: string
key:
type: string
type:
type: string
CurrencyCode:
type: string
description: ISO 4217 currency code supported by Vendaze.
enum:
- AED
- ARS
- AUD
- BRL
- CAD
- CHF
- CLP
- CNY
- COP
- DKK
- EGP
- EUR
- GBP
- HKD
- ILS
- INR
- JPY
- KWD
- MAD
- MXN
- MYR
- NGN
- NOK
- NZD
- PEN
- QAR
- SAR
- SEK
- SGD
- TRY
- USD
- UYU
- ZAR
example: USD
Owner:
type: object
nullable: true
description: >-
Workspace member responsible for this task. `null` when no owner is
assigned.
properties:
id:
type: string
format: uuid
name:
type: string
example: John Smith
email:
type: string
format: email
example: john@company.com
responses:
Unauthorized:
description: >-
Token missing, invalid, or expired. Possible error codes:
`unauthorized`, `token_expired`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: unauthorized
message: Missing or invalid Authorization header.
request_id: 550e8400-e29b-41d4-a716-446655440000
InsufficientScope:
description: 'Token lacks the required scope. Error code: `insufficient_scope`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: insufficient_scope
message: This endpoint requires the 'webhooks:read' scope.
request_id: 550e8400-e29b-41d4-a716-446655440000
NotFound:
description: >-
Webhook not found or belongs to another integration. Error code:
`not_found`. Message: `"Webhook not found."`
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: not_found
message: Webhook not found.
request_id: 550e8400-e29b-41d4-a716-446655440000
InternalError:
description: 'Unexpected server error. Error code: `internal_error`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: internal_error
message: An unexpected error occurred.
request_id: 550e8400-e29b-41d4-a716-446655440000
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: OAuth 2.1 access token.
````