List deals

GET /deals

List deals

cURL

curl --request GET \
  --url https://app.leonar.app/api/v1/deals \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.leonar.app/api/v1/deals"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.leonar.app/api/v1/deals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.leonar.app/api/v1/deals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.leonar.app/api/v1/deals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.leonar.app/api/v1/deals")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.leonar.app/api/v1/deals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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",
      "primary_source_id": "a7b8c9d0-1234-56ef-abcd-789012345ef1",
      "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
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key"
  }
}

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

updated_after · string<date-time>

Return resources changed after this RFC 3339 timestamp. Contacts may redeliver rows exactly at the boundary; consumers must upsert idempotently.

updated_before · string<date-time>

Return resources with updated_at less than or equal to this RFC 3339 timestamp.

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

200

application/json

List of deals

data · object[]

Show child attributes

meta · object

Show child attributes

Example:

{
  "total": 142,
  "limit": 50,
  "offset": 0,
  "has_more": true
}