Opportunity Search

post

https://api.marketcircle.net/v1/opportunities/_search

Search for opportunities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

Opportunity-specific notes

state takes one of open, won, suspended, abandoned or lost:
{ "state": { "any": ["open", "suspended"] } }
total is compared in whole currency units, and decimals in the operand are dropped:
{ "total": { "greater_than_equal": 1000 } }
probability (0 to 100) and priority (0 to 10) are numbers and must be sent as JSON numbers:
{ "probability": { "in_range": [50, 75] } }
category and type match by name, e.g. { "type": { "equal": "New Business" } }.
Contacts and companies take a search filter for that record type with any, so you can match by reference or by any of its attributes:
{ "companies": { "any": { "company": { "equal": "/v1/companies/1000" } } } }
{ "contacts": { "any": { "last_name": { "equal": "Smith" } } } }
Linked records (appointments, notes, tasks, groups, forms, email_messages) work the same way, using the linked record's reference:
{ "tasks": { "any": { "task": { "equal": "/v1/tasks/1000" } } } }
role matches the name of a role a contact or company has on the opportunity, e.g. { "role": { "equal": "Decision Maker" } }.
opportunity and opportunity_id match the opportunity itself, by reference or by numeric ID.

Query Params

limit

int32

≤ 250

Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

full-records

boolean

Return every attribute of each result instead of the short list form.

start

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params

name

object

Example: Sell Sea Shells

state

object

Opportunity state

type

object

Opportunity type name, e.g. New Business

probability

object

Percentage from 0 to 100, e.g. {"in_range": [50, 75]}

priority

object

Priority from 0 to 10

total

object

Total value in whole currency units, e.g. {"greater_than": 1000}. Decimals in the operand are dropped

forecasted

object

Expected closing date

start

object

Start date

end

object

End (closing) date

Opportunity-specific notes

200200 OK

400400 Bad Request