{"info":{"title":"HoundDog Account API (BETA)","description":"Beta Version of the HoundDog Account API.  Requests are rate limited per API key: 300 requests per minute by default, and a different limit can be set for a key by HoundDog support.","contact":{"name":"HoundDog","email":"support@hounddog.com"},"version":"0.0.1"},"swagger":"2.0","produces":["application/xml","application/json","application/octet-stream","text/plain"],"host":"app.hounddog.com","basePath":"/","tags":[{"name":"vendors","description":"Operations about vendors"},{"name":"certificates","description":"Operations about certificates"},{"name":"projects","description":"Operations about projects"},{"name":"insurance_requirements","description":"Operations about insurance_requirements"},{"name":"events","description":"Operations about events"},{"name":"documents","description":"Operations about documents"}],"paths":{"/api/v1/vendors":{"get":{"summary":"List Vendors","description":"Return all vendors on your account","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"query","name":"page","description":"Page offset to fetch.","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of results to return per page.","type":"integer","format":"int32","default":20,"required":false},{"in":"query","name":"offset","description":"Pad a number of results.","type":"integer","format":"int32","default":0,"required":false}],"responses":{"200":{"description":"Return all vendors on your account"}},"tags":["vendors"],"operationId":"getApiV1Vendors"}},"/api/v1/vendors/{id}":{"get":{"summary":"Get Vendor by id","description":"Return details on an individual vendor","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the vendor","type":"string","required":true}],"responses":{"200":{"description":"Return details on an individual vendor"}},"tags":["vendors"],"operationId":"getApiV1VendorsId"}},"/api/v1/vendors/external_id/{external_id}":{"get":{"summary":"Get Vendor by external_id","description":"Return an Vendor by External Id","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"external_id","description":"External ID of the vendor","type":"string","required":true}],"responses":{"200":{"description":"Return an Vendor by External Id"}},"tags":["vendors"],"operationId":"getApiV1VendorsExternalIdExternalId"}},"/api/v1/vendors/create":{"post":{"summary":"Create Vendor","description":"Creates a new Vendor","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"formData","name":"name","description":"New Vendor's name","type":"string","required":true},{"in":"formData","name":"email","description":"Contact email for new Vendor.  Complaince requests will be sent to this address","type":"string","required":true},{"in":"formData","name":"external_id","description":"An arbitrary id for matching ids in external systems.  Can be used to lookup via the /external_id endpoint","type":"string","required":false},{"in":"formData","name":"phone_number","description":"Contact phone for new Vendor.  Complaince requests will be sent to this number","type":"string","required":false},{"in":"formData","name":"contact_first_name","description":"First name of the individual who will be receiving communcations","type":"string","required":false},{"in":"formData","name":"contact_last_name","description":"Last name of the individual who will be receiving communcations","type":"string","required":false},{"in":"formData","name":"insurance_requirement_id","description":"The ID of the insurance requirements for this Vendor.  Defaults to account set default requirements","type":"integer","format":"int32","required":false},{"in":"formData","name":"insurance_requirement_ids","description":"Several insurance requirement IDs for this Vendor, all enforced together.  Only on accounts with multiple insurance requirements enabled, and not alongside insurance_requirement_id.  The first is the vendor's primary requirement (the one insurance_requirement_id reports).","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"formData","name":"collect_compliance_on","description":"Stored on the vendor but has no effect on its own: the date only applies together with started_in_compliance, which API v1 does not accept.","type":"string","format":"date-time","required":false},{"in":"formData","name":"insurance_contact_email","description":"The email address of the Vendor's insurance contact (agent).  If set insurance compliance requests will be sent directly to the insurance contact first. Should be set only in single agency scenarios","type":"string","required":false},{"in":"formData","name":"insurance_contact_name","description":"The name of the Vendor's insurance contact. Should be set only in single agency scenarios","type":"string","required":false},{"in":"formData","name":"insurance_contact_phone","description":"The contact phone of the Vendor's insurance contact","type":"string","required":false},{"in":"formData","name":"insurance_agency_name","description":"The name of the Vendor's Agency. Should be set only in single agency scenarios","type":"string","required":false},{"in":"formData","name":"project_ids","description":"A comma seperated list of project ids to attach the Vendor to. Should be set only in single agency scenarios","type":"string","required":false}],"responses":{"201":{"description":"Creates a new Vendor"}},"tags":["vendors"],"operationId":"postApiV1VendorsCreate"}},"/api/v1/certificates":{"get":{"summary":"List Certificates","description":"Return all certificates on your account","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"query","name":"page","description":"Page offset to fetch.","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of results to return per page.","type":"integer","format":"int32","default":20,"required":false},{"in":"query","name":"offset","description":"Pad a number of results.","type":"integer","format":"int32","default":0,"required":false}],"responses":{"200":{"description":"Return all certificates on your account"}},"tags":["certificates"],"operationId":"getApiV1Certificates"}},"/api/v1/certificates/{id}":{"get":{"summary":"Get Certificate by id","description":"Returns details about an individual certificate","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the certificate","type":"string","required":true}],"responses":{"200":{"description":"Returns details about an individual certificate"}},"tags":["certificates"],"operationId":"getApiV1CertificatesId"}},"/api/v1/projects":{"get":{"summary":"List Projects","description":"Return all projects on your account","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"query","name":"page","description":"Page offset to fetch.","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of results to return per page.","type":"integer","format":"int32","default":20,"required":false},{"in":"query","name":"offset","description":"Pad a number of results.","type":"integer","format":"int32","default":0,"required":false}],"responses":{"200":{"description":"Return all projects on your account"}},"tags":["projects"],"operationId":"getApiV1Projects"}},"/api/v1/projects/{id}":{"get":{"summary":"Get Project by id","description":"Return details on an individual project","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the project","type":"string","required":true}],"responses":{"200":{"description":"Return details on an individual project"}},"tags":["projects"],"operationId":"getApiV1ProjectsId"}},"/api/v1/insurance_requirements":{"get":{"summary":"List Insurance Requirements","description":"Return all insurance requirements on your account","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"query","name":"page","description":"Page offset to fetch.","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of results to return per page.","type":"integer","format":"int32","default":20,"required":false},{"in":"query","name":"offset","description":"Pad a number of results.","type":"integer","format":"int32","default":0,"required":false}],"responses":{"200":{"description":"Return all insurance requirements on your account"}},"tags":["insurance_requirements"],"operationId":"getApiV1InsuranceRequirements"}},"/api/v1/insurance_requirements/{id}":{"get":{"summary":"Get Insurance Requirement by id","description":"Return details on an individual insurance requirements","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the requirement set","type":"string","required":true}],"responses":{"200":{"description":"Return details on an individual insurance requirements"}},"tags":["insurance_requirements"],"operationId":"getApiV1InsuranceRequirementsId"}},"/api/v1/events":{"get":{"summary":"List Events","description":"Return a list of events. Can be filtered by User or Party","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"query","name":"page","description":"Page offset to fetch.","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of results to return per page.","type":"integer","format":"int32","default":20,"required":false},{"in":"query","name":"offset","description":"Pad a number of results.","type":"integer","format":"int32","default":0,"required":false},{"in":"query","name":"user_id","description":"The ID of a user to filter results to","type":"integer","format":"int32","required":false},{"in":"query","name":"party_id","description":"The ID of an Party to filter results to","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Return a list of events. Can be filtered by User or Party"}},"tags":["events"],"operationId":"getApiV1Events"}},"/api/v1/events/{id}":{"get":{"summary":"Get Event by id","description":"Return details on an individual event","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the event","type":"string","required":true}],"responses":{"200":{"description":"Return details on an individual event"}},"tags":["events"],"operationId":"getApiV1EventsId"}},"/api/v1/documents":{"get":{"summary":"List Vendors","description":"Return all documents attached to your account","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"query","name":"page","description":"Page offset to fetch.","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of results to return per page.","type":"integer","format":"int32","default":20,"required":false},{"in":"query","name":"offset","description":"Pad a number of results.","type":"integer","format":"int32","default":0,"required":false}],"responses":{"200":{"description":"Return all documents attached to your account"}},"tags":["documents"],"operationId":"getApiV1Documents"}},"/api/v1/documents/vendor/{id}":{"get":{"summary":"Get Documents by Vendor","description":"Return an individual vendor's documents","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the vendor","type":"string","required":true}],"responses":{"200":{"description":"Return an individual vendor's documents"}},"tags":["documents"],"operationId":"getApiV1DocumentsVendorId"}},"/api/v1/documents/{id}":{"get":{"summary":"Get Document by Id","description":"Return a Document by Id","produces":["application/json"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"path","name":"id","description":"ID of the Document","type":"string","required":true}],"responses":{"200":{"description":"Return a Document by Id"}},"tags":["documents"],"operationId":"getApiV1DocumentsId"}},"/api/v1/documents/create":{"post":{"summary":"Create Document","description":"Creates a new Document","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"header","name":"Api-Key","description":"Valdates your identity","type":"string","required":true},{"in":"formData","name":"document_file","description":"Actual Document File","type":"file","required":true},{"in":"formData","name":"name","description":"Friendly name for document file","type":"string","required":true},{"in":"formData","name":"party_id","description":"ID of the associated Vendor","type":"string","required":true}],"responses":{"201":{"description":"Creates a new Document"}},"tags":["documents"],"operationId":"postApiV1DocumentsCreate"}}}}