Query parameters

• limit integer

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  Minimum value is 1, maximum value is 100. Default value is 10.

• starting_after string

  A cursor for use in pagination. starting_after is an policy ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with pl_fOo123, your subsequent call can include starting_after=pl_fOo123 in order to fetch the next page of the list.

• ending_before string

  A cursor for use in pagination. ending_before is an policy ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with pl_bAr123, your subsequent call can include ending_before=pl_bAr123 in order to fetch the previous page of the list.

• quote string

  A filter to return policies by a specific quote ID.

Responses

• 200 application/json

  An array of policies, up to limit. Each entry in the array is a separate policy object. If no more charges are available, the resulting array will be empty.

  Hide response attributes Show response attributes object

  • certificates object

    URLs to the certificates of insurance for each of the types of coverage issued to the contractor for the specific job assignment.

    Hide certificates attributes Show certificates attributes object

    • gl_coi_pdf_url string

      The general liability certificate of insurance PDF URL.

    • wc_coi_pdf_url string

      The workers compensation certificate of insurance PDF URL.

  • created integer(int64)

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • effective_date integer(int64)

    A timestamp used to determine the insurance policy start date. Measured in seconds since the Unix epoch. The default effective_date is the next day.

  • expiration_date integer(int64)

    A timestemp used to determine the insurance policy end date. Measured in seconds since the Unix epoch. The default expiration_date is 30 days after the effective_date.

  • id string
  • pdf_url string

    A URL for the hosted insurnace policy PDF, which contractors can view.

  • quote string

    The ID of the quote used to create the policy.

  • status

    One of active, cancelled, or expired.

    Values are active, cancelled, or expired.