operation get api v1 contractors parameter policies.md
List a contractor's policies
GET /api/v1/contractors/{contractor}/policies
Returns a list of policies for a given contractor.
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Path parameters
- contractor (string)
The ID of the desired contractor (e.g.,cn_Ehb3bYa).
Query parameters
- quote (string)
A filter to return policies by a specific quote ID.
Responses
200
Returns a list of the contractors policies. The policies are returned sorted by creation date, with the most recent policy appearing first.
Body: application/json (array[object])
certificates (object)
created (integer(int64))
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 timestamp 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 insurance policy PDF, which contractors can view.quote (string)
The ID of the quote used to create the policy.status ()
One ofactive,cancelled, orexpired.