List deals
GET
/v1/deals
deals.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
| Name | Type | Description |
|---|---|---|
page
|
integer | Page number (from 1, default 1) |
per_page
|
integer | Items per page (default 25, max 200) |
client_id
|
string | |
status
|
string | Free filter; recommended open|won|lost |
pipeline_id
|
string | Filter by pipeline_id (UUID) |
phase_id
|
string | Filter by phase_id (UUID) |
legacy_pipeline_id
|
integer | Legacy integer filter; removed in v2. |
legacy_phase_id
|
integer | Legacy integer filter; removed in v2. |
Request body
None
Response
data
array
id
string
title
string
amount
number
status
string
Strict on `POST /v1/deals/{id}/move`. On create/update the API does not reject other strings; UI/domain uses these three (recommended).
Enum
open
won
lost
Example:
open
priority
string
Free string in API (default `medium` when empty). UI/domain uses low|medium|high (recommended).
Enum
low
medium
high
Example:
medium
pipeline_id
string
phase_id
string
client_id
string
expected_close_date
string
created_at
string
meta
object
page
integer
per_page
integer
total
integer
pages
integer
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"title": "string",
"amount": 0,
"status": "open",
"priority": "medium",
"pipeline_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"phase_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"expected_close_date": "2026-07-01",
"created_at": "2026-07-01T12:00:00+00:00"
}
],
"meta": {
"page": 0,
"per_page": 0,
"total": 0,
"pages": 0
}
}Examples
GET /v1/deals
curl -X GET "https://api.appficient.nl/v1/deals" \
-H "Authorization: Bearer apf_xxxxxxxx" \
-H "Accept: application/json"import requests
url = 'https://api.appficient.nl/v1/deals'
headers = {
'Authorization': 'Bearer apf_xxxxxxxx',
'Accept': 'application/json',
}
response = requests.get(url, headers=headers)
data = response.json()
const url = 'https://api.appficient.nl/v1/deals';
const options = {
method: 'GET',
headers: {
Authorization: 'Bearer apf_xxxxxxxx',
Accept: 'application/json',
},
};
const res = await fetch(url, options);
const json = await res.json();
<?php
$url = 'https://api.appficient.nl/v1/deals';
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer apf_xxxxxxxx',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$json = json_decode($response, true);
postman request GET 'https://api.appficient.nl/v1/deals' \
--header 'Authorization: Bearer apf_xxxxxxxx' \
--header 'Accept: application/json'using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "apf_xxxxxxxx");
client.DefaultRequestHeaders.Accept.Add(
new MediaTypeWithQualityHeaderValue("application/json"));
using var request = new HttpRequestMessage(
HttpMethod.Get,
"https://api.appficient.nl/v1/deals");
var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
.uri(URI.create("https://api.appficient.nl/v1/deals"))
.header("Accept", "application/json")
.header("Authorization", "Bearer apf_xxxxxxxx");
HttpRequest request = builder.GET().build();
HttpResponse<String> response = client.send(
request, HttpResponse.BodyHandlers.ofString());
String json = response.body();
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, err := http.NewRequest("GET", "https://api.appficient.nl/v1/deals", nil)
if err != nil {
panic(err)
}
req.Header.Set("Accept", "application/json")
req.Header.Set("Authorization", "Bearer apf_xxxxxxxx")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(data))
}
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.appficient.nl/v1/deals')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
req = Net::HTTP::Get.new(uri)
req['Accept'] = 'application/json'
req['Authorization'] = 'Bearer apf_xxxxxxxx'
res = http.request(req)
data = JSON.parse(res.body)
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"title": "string",
"amount": 0,
"status": "open",
"priority": "medium",
"pipeline_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"phase_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"expected_close_date": "2026-07-01",
"created_at": "2026-07-01T12:00:00+00:00"
}
],
"meta": {
"page": 0,
"per_page": 0,
"total": 0,
"pages": 0
}
}Curl, Node and response are shown to the right of this endpoint.