- Getting Started with HYEGRO API
- User Guide
- Developer Guide
- HYEGRO Developer Docs
- HYEGRO CRM API v1.0
- Users
- Leads
- Contacts
- Accounts
- Products & Inventory
- Deals
- Quotations
- Orders
- Invoices
- Cases
- Activities & Tasks
- Search
- METADATA API
- Files & Attachments
Read Deal
GET
https://backend.test-hyegro.com/deals/{deal_id}
Request
Path Params
deal_id
integer
Deal Id
Query Params
schema
Schema
Any of
Responses
🟢200OK
application/json
Body
name
string
Name
account_id
Account Id
Any of
contact_id
Contact Id
Any of
value
number
Value
currency
Currency
Any of
stage
string
Stage
probability
Probability
Any of
close_date
Close Date
Any of
estimated_closure_date
Estimated Closure Date
Any of
user_id
User Id
Any of
lead_id
Lead Id
Any of
deal_type
Deal Type
Any of
campaign_source
Campaign Source
Any of
description
Description
Any of
expected_revenue
Expected Revenue
Any of
tags
Tags
Any of
competitor
Competitor
Any of
next_step
Next Step
Any of
closed_lost_comment
Closed Lost Comment
Any of
created_by
Created By
Any of
updated_by
Updated By
Any of
created_by_name
Created By Name
Any of
updated_by_name
Updated By Name
Any of
account_name
Account Name
Any of
contact_name
Contact Name
Any of
assigned_to
Assigned To
Any of
assigned_to_name
Assigned To Name
Any of
cf1
Cf1
Any of
cf2
Cf2
Any of
cf3
Cf3
Any of
cf4
Cf4
Any of
cf5
Cf5
Any of
cf6
Cf6
Any of
cf7
Cf7
Any of
cf8
Cf8
Any of
cf9
Cf9
Any of
cf10
Cf10
Any of
id
integer
Id
created_at
string <date-time>
Created At
updated_at
string <date-time>
Updated At
Example
{
"name": "string",
"account_id": 0,
"contact_id": 0,
"value": 0,
"currency": "string",
"stage": "string",
"probability": 0,
"close_date": "2019-08-24T14:15:22Z",
"estimated_closure_date": "2019-08-24T14:15:22Z",
"user_id": 0,
"lead_id": 0,
"deal_type": "string",
"campaign_source": "string",
"description": "string",
"expected_revenue": "string",
"tags": [
"string"
],
"competitor": "string",
"next_step": "string",
"closed_lost_comment": "string",
"created_by": 0,
"updated_by": 0,
"created_by_name": "string",
"updated_by_name": "string",
"account_name": "string",
"contact_name": "string",
"assigned_to": "string",
"assigned_to_name": "string",
"cf1": "string",
"cf2": "string",
"cf3": "string",
"cf4": "string",
"cf5": "string",
"cf6": "string",
"cf7": "string",
"cf8": "string",
"cf9": "string",
"cf10": "string",
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
🟠422Parameter Error
Modified at 2025-04-15 14:01:56