Skip to main content
GET
/
deals
/
{uuid}
Get a deal
curl --request GET \
  --url https://api.journeybee.io/v1/deals/{uuid} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "<string>",
  "label": "<string>",
  "deal_value": 123,
  "total_commission_value": 123,
  "expiration_date": "<string>",
  "stage": {
    "uuid": "<string>",
    "label": "<string>"
  },
  "lead": {
    "uuid": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "company_name": "<string>"
  },
  "partner": {
    "uuid": "<string>",
    "name": "<string>"
  },
  "currency": {
    "uuid": "<string>",
    "code": "<string>",
    "label": "<string>"
  },
  "tags": [
    {
      "uuid": "<string>",
      "label": "<string>"
    }
  ],
  "assigned_users": [
    {
      "uuid": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ],
  "custom_fields": [
    {
      "uuid": "<string>",
      "label": "<string>",
      "value": {
        "text": "<string>",
        "number": 123,
        "date": "<string>",
        "boolean": true,
        "select": 123,
        "multi_select": [
          123
        ]
      },
      "options": [
        {
          "id": 123,
          "label": "<string>"
        }
      ]
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
label
string
required
deal_value
number
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

total_commission_value
number | null
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

expiration_date
string | null
required
stage
object
required
lead
object
required
partner
object
required
currency
object
required
tags
object[]
required
assigned_users
object[]
required
custom_fields
object[]
required
created_at
string
required
updated_at
string
required