Build with Estii

List deals

GET
/v1/deal

Requires read scope.

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token (estp_) or space API key (ests_).

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
space*string
Length1 <= length
status?string
Default"active"

Value in

  • "active"
  • "archived"
  • "all"
  • "draft"
  • "approved"
  • "progressed"
  • "won"
  • "lost"
  • "abandoned"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deal?space=string"
{  "items": [    {      "id": "string",      "name": "string",      "status": "string",      "updated_at": 0,      "space_id": "string",      "currency": "string",      "price": 0,      "margin": 0,      "probability": 0,      "archived": true    }  ],  "next_cursor": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}