Skip to main content
GET
/
deals
List deals
curl --request GET \
  --url https://app.leonar.app/api/v1/deals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "c3d4e5f6-7890-12ab-cdef-345678901bcd",
      "title": "Recruitment - 3 Senior Engineers",
      "status": "open",
      "amount": 45000,
      "signed_amount": null,
      "currency": "EUR",
      "expected_amount": 45000,
      "expected_close_date": "2025-03-15",
      "probability": 60,
      "pipeline_id": "d4e5f6a7-8901-23bc-defa-456789012cde",
      "stage_id": "e5f6a7b8-9012-34cd-efab-567890123def",
      "company_id": "b2c3d4e5-6789-01ab-cdef-234567890abc",
      "owner_id": "f6a7b8c9-0123-45de-fabc-678901234ef0",
      "closed_at": null,
      "created_at": "2025-02-01T10:00:00Z",
      "updated_at": "2025-02-10T15:30:00Z",
      "archived_at": null
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

API key starting with leo_

Query Parameters

​
limit
integer
default:50

Items per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Items to skip

Required range: x >= 0
​
status
enum<string>
default:all
Available options:
open,
won,
lost,
unqualified,
all
​
pipeline_id
string<uuid>
​
stage_id
string<uuid>
​
company_id
string<uuid>
​
owner_id
string<uuid>
​
search
string

Search by title

​
sort
string
default:-created_at

Options: created_at, updated_at, title, amount, expected_close_date

Response

List of deals

​
data
object[]
​
meta
object
Example:
{
  "total": 142,
  "limit": 50,
  "offset": 0,
  "has_more": true
}