STsteadily
Reporting

Partner Policy

Changed on

List the policies bound for customers you've referred, newest first.

Each policy includes its term, premium, coverages, and properties. Note that the level of detail may vary depending on if it's a Steadily direct policy or a third-party policy bound through Steadily.

get/v1/report/policy

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/policy
  • 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'issued' | 'quoted' | 'cancelled'

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 next_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property policies/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 policies/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 policies/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 policies/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 policies/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 policies/items/properties/items/lead_property_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property policies/items/public_policy_id 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 string to no type for status

    • info

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

    • info

      removed the advance enum value from the // response property for the response status

    • info

      removed the advance_and_transactions enum value from the // response property for the response status

    • info

      removed the annual enum value from the // response property for the response status

    • info

      removed the escrow enum value from the // response property for the response status

    • info

      removed the installments enum value from the // response property for the response status

    • info

      removed the premium_financed enum value from the // response property for the response status

    • info

      removed the transaction enum value from the // response property for the response status