Skip to main content
GET
/
deals
/
List deals
curl --request GET \
  --url https://api.journeybee.io/v1/deals/ \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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>"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
Required range: 1 <= x <= 9007199254740991
per_page
integer
default:25
Required range: 1 <= x <= 100
phase
enum<string>
Available options:
new,
in_progress,
won,
lost,
expired,
on_hold
stage_uuid
string
lead_uuid
string
partnership_uuid
string
Maximum string length: 200
include_archived
boolean
default:false

Response

200 - application/json

Default Response

data
object[]
required
pagination
object
required