STsteadily
Reporting

Partner Lead

Changed on

List the leads you've referred, newest first.

Each lead includes the contact, the properties quoted, and the Steadily agent who is assisting that lead.

Lead statuses indicate how that lead performed:

  • New - Newly created leads.
  • Converted - Leads that convert and buy a policy.
  • Unqualified - Leads that ultimately did not convert.
  • Awaiting quote - Leads that are currently being quoted, pending customer decision or underwriting review.

Account-level reporting also provides a contacted status to indicate whether we've successfully established contact with that customer.

Results are paginated; follow next_url for the next page.

get/v1/report/lead

Request

  • Base URL
    https://api.steadily.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.steadily.com/v1/report/lead
  • Auth
    • API key in query parameter X-Steadily-SecretKey
    • or API key in header X-Steadily-SecretKey

Query parameters

limitinteger
starting_after_idstring nullable
order_by'-created_timestamp' | 'created_timestamp' | '-updated_timestamp' | 'updated_timestamp'
created_afterstring date-time nullable
created_beforestring date-time nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
status'converted' | 'unqualified' | 'awaiting_quote' | 'new'

Response

Successful Response

limitinteger required
next_urlstring nullable

Changes

  • 28ec84365d3eRevision changes
    • info

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

    • info

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

  • a02c0e8f1905Revision changes
    • breaking

      response property leads/items/account_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/date_of_birth list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/email list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/first_name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/last_name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/phone_number list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/self_reported_claims list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/contact/suffix list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/external_record_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/first_name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/last_name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/address/address_1 list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/address/city list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/address/state list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/address/zip list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/external_property_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/construction_type list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/heating_sources list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/intermittent_rental list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/property_type list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/renovation_status list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/rental_duration list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/roof_type list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/total_sq_feet list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/property_details/year_built list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/properties/items/replacement_cost_estimate list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property leads/items/referral_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property next_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from no type to string for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      removed from the // response property allOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status