Skip to main content
GET
/
v1
/
households
/
{household_id}
/
opportunities
List opportunities
curl --request GET \
  --url https://api.slant.app/v1/households/{household_id}/opportunities \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "abc123xyz",
      "name": "New Investment Opportunity",
      "book_id": "book123xyz",
      "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
      },
      "assigned_to": {
        "id": "abc123xyz",
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "api_access": {
          "auth_type": "personal_access_token",
          "scope": "read_write"
        }
      },
      "value": 5000,
      "probability": 75,
      "target_close_date": "2023-11-07T05:31:56Z",
      "stage_updated_at": "2023-11-07T05:31:56Z",
      "household_id": "household123xyz",
      "custom_fields": {
        "lead_source": "Referral"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

​
household_id
string
required

The household ID

Query Parameters

​
page
integer

Page number

​
per_page
integer

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

Required range: 1 <= x <= 100

Response

successful

​
data
object[]
required
​
pagination
object
required