Skip to main content
POST
Search opportunities

Authorizations

x-api-key
string
header
required

Public API key for the Octolane organization.

Body

application/json

Opportunity search body. pipeline_id is optional; omit it to search across all pipelines.

pipeline_id
string
stage_id
string | null
query
string
q
string
filters
object[]
Maximum array length: 50
sort

Compact sort expression. Use field, field:asc, or field:desc.

Pattern: ^[^:]+(?::(asc|desc))?$
cursor
string | null
limit
integer
Required range: 1 <= x <= 500
fields
string[]
Maximum array length: 100

Response

Opportunities were returned.

success
boolean
Example:

true

message
string
data
object

Endpoint-specific response payload.