Skip to main content
GET
/
v1
/
deals
List deals
curl --request GET \
  --url https://api.vendaze.com/v1/deals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Acme Corp Annual Contract",
      "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "price_cts": 250000,
      "currency_id": "BRL",
      "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "referral",
      "forecast_date": "2026-12-31",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 50,
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.1 access token.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:50

Max 100.

Required range: 1 <= x <= 100
​
order_by
string
default:created_at
​
order
enum<string>
default:desc
Available options:
asc,
desc
​
name
string

Partial match on deal name.

​
pipeline_id
string<uuid>

Filter by pipeline.

​
stage_id
string<uuid>

Filter by stage.

​
owner_user_id
string<uuid>

Filter by owner.

​
source
string

Filter by deal source.

​
price_min_cts
integer

Minimum value in cents.

​
price_max_cts
integer

Maximum value in cents.

​
currency
string

ISO 4217 currency code. Example: BRL.

​
forecast_after
string<date-time>

Filter by forecast date after.

​
forecast_before
string<date-time>

Filter by forecast date before.

​
created_after
string<date-time>
​
created_before
string<date-time>
​
updated_after
string<date-time>
​
updated_before
string<date-time>

Response

List of deals returned successfully.

​
data
object[]
​
meta
object