Skip to main content
GET
List all Opportunities

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Query Parameters

expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

page
integer

Pagination: Page number

Required range: x >= 1
limit
integer

Pagination: Limit number of items per page.

Required range: 1 <= x <= 100
metadata
object

Filter by metadata. Use metadata[key]=value to filter by specific metadata keys.

Example:
sort_by
enum<string>

Sorting by attribute. Default created_at

Available options:
created_at,
updated_at
sort_direction
enum<string>

Sorting by ASC or DESC direction. Default DESC

Available options:
ASC,
DESC
contact_id
string[]

Filter by Contact IDs. Supports multiple values separated by a comma.

site_id
string[]

Filter by Site IDs. Supports multiple values separated by a comma.

created_after
string<date-time>

Filters results to created after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

created_before
string<date-time>

Filters results to created before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_after
string<date-time>

Filters results to updated after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_before
string<date-time>

Filters results to updated before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

status
enum<string>[]

Filter by opportunity status. Supports multiple values separated by comma.

Available options:
open,
archived,
associated
source
enum<string>[]

Filter by the origin of the opportunity. Supports multiple values separated by comma. unspecified will filter by null value.

Available options:
incomplete_booking,
price_reveal,
quote_requested,
unit_type_interest,
pre_opening_lead,
popup_form,
public_api,
unspecified

Response

200 - application/json

list of opportunities

List of Opportunities

opportunities
object[]
meta
object