Resources
Opportunities
An opportunity is a lead or potential project. Once approved, an opportunity becomes a project, both share the same record, distinguished by the approval_status field.
POST
/v1/opportunitiesCreate an opportunity
Creates a new opportunity in your workspace. Every field is optional, you can create a blank opportunity and fill it in later via the dashboard.
Body parameters
| Name | Type | Description |
|---|---|---|
| contact_name | string | Display name of the customer or company. Shown on cards and in lists. |
| primary_contact_id | uuid | Link this opportunity to an existing contact in your workspace. |
| value | number | Estimated dollar value. Must be non-negative. |
| lead_source | string | Where the lead came from (free text, e.g. "Referral", "Google"). |
| appointment_at | string | ISO 8601 timestamp for the first appointment. |
| address_street | string | Job site street address. |
| address_city | string | Job site city. |
| address_state | string | Job site state. |
| address_zip | string | Job site ZIP / postal code. |
| address_country | string | Job site country. |
| sales_rep_id | uuid | Workspace user assigned as sales rep. |
| project_manager_id | uuid | Workspace user assigned as project manager. |
| ar_owner_id | uuid | Workspace user assigned as AR owner. |
| pipeline_id | uuid | Pipeline to place the opportunity in. Defaults to the workspace default opportunity pipeline. |
| stage_id | uuid | Specific pipeline stage. If omitted, the first stage of the pipeline is used. |
| tags | string[] | Array of tag strings. |
Returns
HTTP 201 Created with the full opportunity object.
GET
/v1/opportunitiesList opportunities
Returns opportunities in your workspace, most recently created first.
Query parameters
| Name | Type | Description |
|---|---|---|
| q | string | Free-text search across name and contact_name. |
| contact_name | string | Filter by contact_name (substring match). |
| approval_status | enum | One of: opportunity, project, archived. |
| limit | number | Max records to return. 1–100. Default 25. |