Skip to main content
GET
List deals

Authorizations

Authorization
string
header
required

A workspace API key, created in workspace settings and sent as Authorization: Bearer op_live_…. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.

Query Parameters

limit
integer
default:50

Page size, 1–200. Defaults to 50. Values outside the range are clamped rather than rejected.

Required range: 1 <= x <= 200
cursor
string

nextCursor from the previous page. An unreadable cursor is ignored and the first page is returned, so check nextCursor for null rather than looping until a page comes back empty.

Response

Deals most-recently-updated first. One page is not the pipeline — the board shows every column by fetching until nextCursor is null, and anything summing a single page is summing an arbitrary slice of it.

One page of deals, newest or strongest first depending on the endpoint.

items
object[]
required

Up to limit deals.

nextCursor
string | null
required

Pass as cursor to fetch the next page. null on the last page — which is the only reliable way to know you have reached it, since a full page can still be the last one.