Sign in

v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Opportunities

List opportunities

List all opportunities. Optionally filter by book_id, pipeline_type, pipeline_id, pipeline_stage_id, or household_id

get/v1/opportunities

Query parameters

book_idstring

Filter by book ID

pipeline_type'prospect' | 'client'

Filter by pipeline type

pipeline_idstring

Filter by pipeline ID

pipeline_stage_idstring

Filter by pipeline stage ID

household_idstring

Filter by household ID

Response

opportunities filtered by household_id

Example response

{
  "data": [
    {
      "id": "abc123xyz",
      "name": "New Investment Opportunity",
      "value": 5000,
      "probability": 75,
      "book_id": "book123xyz",
      "household_id": "household123xyz",
      "pipeline": {
        "id": "pipeline123xyz",
        "name": "Sales Pipeline",
        "pipeline_type": "prospect",
        "book_id": "book123xyz",
        "pipeline_stages": [
          {
            "id": "stage123xyz",
            "name": "Qualified",
            "stage_order": 1,
            "visible": true,
            "default_probability": 50
          }
        ]
      },
      "pipeline_stage": {
        "id": "stage123xyz",
        "name": "Qualified",
        "stage_order": 1,
        "visible": true,
        "default_probability": 50
      },
      "custom_fields": {
        "lead_source": "Referral"
      },
      "assigned_to": {
        "id": "abc123xyz",
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "api_access": {
          "auth_type": "personal_access_token",
          "scope": "read_write"
        }
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}