Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

Your API key, created in the Leadey dashboard under Settings → API Keys. Send it as Authorization: Bearer leadey_sk_live_….

Query Parameters

page
integer
default:1

1-based page number.

Required range: x >= 1
pageSize
integer
default:25

Items per page (max 100).

Required range: 1 <= x <= 100

Free-text search across the resource's key fields.

pipelineId
string

Only deals in this pipeline.

stageId
string

Only deals in this stage.

status
enum<string>

Filter by the stage's type.

Available options:
open,
won,
lost
ownerId
string

Only deals owned by this user.

currency
string

ISO currency code, e.g. GBP.

minValue
string

Minimum deal value, compared numerically.

Example:

"1000"

maxValue
string

Maximum deal value, compared numerically.

expectedCloseAfter
string<date>

Expected close on or after this date.

expectedCloseBefore
string<date>

Expected close on or before this date.

createdFrom
string<date-time>

Created on or after.

createdTo
string<date-time>

Created on or before.

closedFrom
string<date-time>

Closed on or after.

closedTo
string<date-time>

Closed on or before.

Response

Success.

data
object[]
meta
object