List Deals - Liveforce

Retrieves a list of all deals.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic *****************

Query Params

pipeline_id

string

optional

Example:

source_id

string

optional

Example:

custom_view

string

optional

created_today, created_this_week, created_last_week, created_this_month, created_last_month, customer, lead, contract, proposal

Example:

created_today

limit

string

optional

Example:

offset

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array [object {26}]

required

string

optional

title

string

optional

deal_value

string

optional

source_id

string

optional

status

string

optional

notes

null

optional

pipeline_id

string

optional

currency

string

optional

created_at

string

optional

days_to_close

string

optional

user_id

string

optional

project_id

null

optional

invoice_id

null

optional

client_id

string

optional

rel_type

string

optional

rel_id

string

optional

stage_id

string

optional

default_deal_owner

string

optional

convert_to_project

null

optional

lost_reason

null

optional

tax

null

optional

total_tax

null

optional

dealorder

string

optional

stage_name

string

optional

source_name

string

optional

pipeline_name

string

optional

page

object

required

current_page

integer

required

from

integer

required

integer

required

total

integer

required

per_page

integer

required

last_page

integer

required

integer

required

integer

required

message

string

required

Example

{
  "data": [
    {
      "id": "1",
      "title": "Deal 1",
      "deal_value": "100.00",
      "source_id": "1",
      "status": "open",
      "notes": null,
      "pipeline_id": "1",
      "currency": "USD",
      "created_at": "2024-08-12 18:05:43",
      "days_to_close": "2024-08-19",
      "user_id": "[\"1\"]",
      "project_id": null,
      "invoice_id": null,
      "client_id": "null",
      "rel_type": "lead",
      "rel_id": "1",
      "stage_id": "2",
      "default_deal_owner": "1",
      "convert_to_project": null,
      "lost_reason": null,
      "tax": null,
      "total_tax": null,
      "dealorder": "1",
      "stage_name": "Contact Made",
      "source_name": "Facebook",
      "pipeline_name": "Sales"
    }
  ],
  "page": {
    "current_page": 1,
    "from": 1,
    "to": 1,
    "total": 1,
    "per_page": 10,
    "last_page": 0,
    "next": -1,
    "previous": 0
  },
  "message": "success"
}

🟠401Unauthorized