SLslant
Opportunities

List opportunities

Changed on

List all opportunities for a household

get/v1/households/{household_id}/opportunities

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/households/{household_id}/opportunities
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number

per_pageinteger

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

pipeline_type'prospect' | 'client'
pipeline_idstring
pipeline_stage_idstring

Response

successful

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
  }
}

Changes

  • 173c41bf6be9Revision changes
    • breaking

      the response property //////// became nullable for the status

    • warning

      added the new oauth enum value to the //////// response property for the response status

    • info

      added the new optional query request parameter pipeline_id

    • info

      added the new optional query request parameter pipeline_stage_id

    • info

      added the new optional query request parameter pipeline_type

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400