Skip to main content
GET
/
api
/
v1
/
lead-deals
Get Deals
curl --request GET \
  --url https://app.journeybee.io/api/v1/lead-deals \
  --header 'Authorization: Bearer <token>'
[
  {
    "total": 1,
    "id": 456,
    "uuid": "deal-uuid-456",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T14:20:00Z",
    "label": "TechCorp Enterprise Deal",
    "deal_value": 250000,
    "lead_id": 789,
    "company_id": 123,
    "partner_type": "reseller",
    "stage_id": 3,
    "stage_label": "Negotiation",
    "stage_series": 3,
    "stage_phase": "negotiation",
    "payment_stage_id": 2,
    "payment_stage_label": "Invoice Sent",
    "payment_stage_series": 2,
    "payment_stage_phase": "pending",
    "currency_id": 1,
    "currency_code": "USD",
    "partnership_id": 234,
    "campaign_id": null,
    "campaign_title": null,
    "company_campaign_id": null,
    "vendor_stage_id": 4,
    "commission_amount": 25000,
    "commission_percentage": 10,
    "tags": [
      {
        "id": 15,
        "label": "Enterprise",
        "background_color": "#8B5CF6",
        "text_color": "#FFFFFF"
      }
    ],
    "assigned_users": [
      {
        "id": 456,
        "email": "sales@company.com",
        "first_name": "Sarah",
        "last_name": "Johnson",
        "profile_image_id": 890,
        "profile_image_uuid": "profile-uuid-890"
      }
    ],
    "associated_partner": [
      {
        "company_id": 345,
        "company_name": "Partner Solutions Inc",
        "company_logo_id": 678,
        "company_logo_uuid": "logo-uuid-678"
      }
    ],
    "campaign_partners": []
  }
]

​
Authentication

curl -X GET "https://app.journeybee.io/api/v1/lead-deals?view=received" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json"

​
Query Parameters

​
view
string
Filter by deal type/source. Options: received, sent, reseller, campaigns
​
cursor
string
Pagination cursor (ISO timestamp) for fetching the next set of results
​
search
string
Search deals by deal name, lead company name, email, phone, assigned users, or partner companies
​
assigned
number
Filter by assignment status. Use 1 to show only assigned deals
​
unassigned
number
Filter by assignment status. Use 1 to show only unassigned deals
​
showPartnersStages
number
For reseller deals, show partner’s stages instead of your stages. Use 1 to enable
​
stages
string
Comma-separated list of stage IDs to filter by
​
phases
string
Comma-separated list of phase IDs to filter by (for sent deals)
​
tags
string
Comma-separated list of tag IDs to filter by
​
users
string
Comma-separated list of user IDs to filter by assigned users
​
partnershipIds
string
Comma-separated list of partnership IDs to filter by

​
Response Schema

​
deals
array
Array of deal objects

​
Example Request

curl -X GET "https://app.journeybee.io/api/v1/lead-deals?view=reseller&showPartnersStages=1&search=tech" \
  -H "Authorization: Bearer jb_api_1234567890abcdef" \
  -H "Content-Type: application/json"

​
Example Response

[
  {
    "total": 1,
    "id": 456,
    "uuid": "deal-uuid-456",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T14:20:00Z",
    "label": "TechCorp Enterprise Deal",
    "deal_value": 250000,
    "lead_id": 789,
    "company_id": 123,
    "partner_type": "reseller",
    "stage_id": 3,
    "stage_label": "Negotiation",
    "stage_series": 3,
    "stage_phase": "negotiation",
    "payment_stage_id": 2,
    "payment_stage_label": "Invoice Sent",
    "payment_stage_series": 2,
    "payment_stage_phase": "pending",
    "currency_id": 1,
    "currency_code": "USD",
    "partnership_id": 234,
    "campaign_id": null,
    "campaign_title": null,
    "company_campaign_id": null,
    "vendor_stage_id": 4,
    "commission_amount": 25000,
    "commission_percentage": 10,
    "tags": [
      {
        "id": 15,
        "label": "Enterprise",
        "background_color": "#8B5CF6",
        "text_color": "#FFFFFF"
      }
    ],
    "assigned_users": [
      {
        "id": 456,
        "email": "sales@company.com",
        "first_name": "Sarah",
        "last_name": "Johnson",
        "profile_image_id": 890,
        "profile_image_uuid": "profile-uuid-890"
      }
    ],
    "associated_partner": [
      {
        "company_id": 345,
        "company_name": "Partner Solutions Inc",
        "company_logo_id": 678,
        "company_logo_uuid": "logo-uuid-678"
      }
    ],
    "campaign_partners": []
  }
]

​
Error Responses

{
  "error": "Invalid API key or insufficient permissions"
}

{
  "error": "Read access required for this operation"
}

​
Notes

  • Requires API key with read_access permission
  • Results are paginated using cursor-based pagination