Home
Endpoints
App Installations
Company
Company Directory
Company Documents
Company Security Settings
Configurations
Cost Codes & Sub Jobs
Direct Costs
Documents
Equipment
Local Files
Permissions
Portfolio
Project
Project Directory
Project Vendor Insurances
Project Documents
Project Filters
Project Links
Project Overview
Settings
Tasks
Workflows
Workflows Legacy
Project Vendor Insurances
GET /rest/v1.0/projects/{project_id}/vendors/{vendor_id}/insurances
Description
Return a list of Insurances from the specified Project Vendor.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
project_idinteger*
Unique identifier for the project.
vendor_idinteger*
Vendor ID
Query Parameters
pageinteger
Page
per_pageinteger
Elements per page
Example Requests
1const request = require('request');
2
3const options = {
4 method: 'GET',
5 url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/vendors/%7Bvendor_id%7D/insurances',
6 qs: {page: 'SOME_INTEGER_VALUE', per_page: 'SOME_INTEGER_VALUE'}
7};
8
9request(options, function (error, response, body) {
10 if (error) throw new Error(error);
11
12 console.log(body);
13});
14Responses
Body
idinteger
ID
effective_datestring(format: date)
Effective date
enable_expired_insurance_notificationsboolean
Enable/Disable expired insurance notifications
exemptboolean
Exempt status
expiration_datestring(format: date)
Expiration date
info_receivedboolean
Information received (or not)
insurance_providerstring
Insurance provider
insurance_typestring
Insurance type
limitstring
Limit
notesstring
Notes
policy_numberstring
Policy number
statusstring
Status
Allowed values:
compliant
compliant_in_progress
expired
non_compliant
non_compliant_in_progress
undecided
unregistered
vendor_idinteger
Vendor ID
additional_insuredstring
Additional Individuals and/or Companies Insured
division_templatestring
Division Template
insurance_setsstring
Insurance Sets
origin_datastring
Origin data
origin_idstring
Origin ID
Response Headers
Per-Pageinteger
Number of items retrieved per page
Totalinteger
Total number of items to be retrieved
Linkstring
Link headers for the first, prev, next, and last link
Example Response
1[
2 {
3 "id": 311823,
4 "effective_date": "2015-03-03",
5 "enable_expired_insurance_notifications": false,
6 "exempt": false,
7 "expiration_date": "2016-03-02",
8 "info_received": false,
9 "insurance_provider": "GL Insurance Inc.",
10 "insurance_type": "General Liability",
11 "limit": "1000000.0",
12 "notes": "Meets minimum requirements",
13 "policy_number": "12345GL",
14 "status": "compliant",
15 "vendor_id": 2627684,
16 "additional_insured": "John Doe",
17 "division_template": "Template 1",
18 "insurance_sets": "Set 1",
19 "origin_data": "OD-2398273424",
20 "origin_id": "ABC123"
21 }
22]POST /rest/v1.0/projects/{project_id}/vendors/{vendor_id}/insurances
Description
Create a new Insurance associated with the specified Project Vendor.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
project_idinteger*
Unique identifier for the project.
vendor_idinteger*
Vendor ID
Example Requests
1const request = require('request');
2
3const options = {
4 method: 'POST',
5 url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/vendors/%7Bvendor_id%7D/insurances',
6 headers: {'content-type': 'application/json'},
7 body: {
8 insurance: {
9 effective_date: '2015-03-03',
10 enable_expired_insurance_notifications: true,
11 exempt: false,
12 expiration_date: '2016-03-02',
13 info_received: false,
14 insurance_type: 'General Liability',
15 limit: '1000000.00',
16 name: 'GL Insurance Inc.',
17 notes: 'Meets minimum requirements',
18 policy_number: '12345GL',
19 status: 'compliant',
20 additional_insured: 'John Doe',
21 division_template: 'Template 1',
22 insurance_sets: 'Set 1',
23 origin_data: 'OD-2398273424',
24 origin_id: 'ABC123'
25 }
26 },
27 json: true
28};
29
30request(options, function (error, response, body) {
31 if (error) throw new Error(error);
32
33 console.log(body);
34});
35Body Parameters
Body
insuranceobject*
Example Request Body
1{
2 "insurance": {
3 "effective_date": "2015-03-03",
4 "enable_expired_insurance_notifications": true,
5 "exempt": false,
6 "expiration_date": "2016-03-02",
7 "info_received": false,
8 "insurance_type": "General Liability",
9 "limit": "1000000.00",
10 "name": "GL Insurance Inc.",
11 "notes": "Meets minimum requirements",
12 "policy_number": "12345GL",
13 "status": "compliant",
14 "additional_insured": "John Doe",
15 "division_template": "Template 1",
16 "insurance_sets": "Set 1",
17 "origin_data": "OD-2398273424",
18 "origin_id": "ABC123"
19 }
20}Responses
Body
idinteger
ID
effective_datestring(format: date)
Effective date
enable_expired_insurance_notificationsboolean
Enable/Disable expired insurance notifications
exemptboolean
Exempt status
expiration_datestring(format: date)
Expiration date
info_receivedboolean
Information received (or not)
insurance_providerstring
Insurance provider
insurance_typestring
Insurance type
limitstring
Limit
notesstring
Notes
policy_numberstring
Policy number
statusstring
Status
Allowed values:
compliant
compliant_in_progress
expired
non_compliant
non_compliant_in_progress
undecided
unregistered
vendor_idinteger
Vendor ID
additional_insuredstring
Additional Individuals and/or Companies Insured
division_templatestring
Division Template
insurance_setsstring
Insurance Sets
origin_datastring
Origin data
origin_idstring
Origin ID
Example Response
1{
2 "id": 311823,
3 "effective_date": "2015-03-03",
4 "enable_expired_insurance_notifications": false,
5 "exempt": false,
6 "expiration_date": "2016-03-02",
7 "info_received": false,
8 "insurance_provider": "GL Insurance Inc.",
9 "insurance_type": "General Liability",
10 "limit": "1000000.0",
11 "notes": "Meets minimum requirements",
12 "policy_number": "12345GL",
13 "status": "compliant",
14 "vendor_id": 2627684,
15 "additional_insured": "John Doe",
16 "division_template": "Template 1",
17 "insurance_sets": "Set 1",
18 "origin_data": "OD-2398273424",
19 "origin_id": "ABC123"
20}PATCH /rest/v1.0/projects/{project_id}/vendors/{vendor_id}/insurances/sync
Description
This endpoint creates or updates a batch of Project Vendor Insurances.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
project_idinteger*
Unique identifier for the project.
vendor_idinteger*
Vendor ID
Example Requests
1const request = require('request');
2
3const options = {
4 method: 'PATCH',
5 url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/vendors/%7Bvendor_id%7D/insurances/sync',
6 headers: {'content-type': 'application/json'},
7 body: {
8 updates: [
9 {
10 id: 348330,
11 effective_date: '2015-03-03',
12 enable_expired_insurance_notifications: true,
13 exempt: false,
14 expiration_date: '2016-03-02',
15 info_received: false,
16 insurance_type: 'General Liability',
17 limit: '1000000.00',
18 name: 'GL Insurance Inc.',
19 notes: 'Meets minimum requirements',
20 policy_number: '12345GL',
21 status: 'compliant',
22 additional_insured: 'John Doe',
23 division_template: 'Template 1',
24 insurance_sets: 'Set 1',
25 origin_data: 'OD-2398273424',
26 origin_id: 'ABC123'
27 }
28 ]
29 },
30 json: true
31};
32
33request(options, function (error, response, body) {
34 if (error) throw new Error(error);
35
36 console.log(body);
37});
38Body Parameters
Body
updatesarray*
Example Request Body
1{
2 "updates": [
3 {
4 "id": 348330,
5 "effective_date": "2015-03-03",
6 "enable_expired_insurance_notifications": true,
7 "exempt": false,
8 "expiration_date": "2016-03-02",
9 "info_received": false,
10 "insurance_type": "General Liability",
11 "limit": "1000000.00",
12 "name": "GL Insurance Inc.",
13 "notes": "Meets minimum requirements",
14 "policy_number": "12345GL",
15 "status": "compliant",
16 "additional_insured": "John Doe",
17 "division_template": "Template 1",
18 "insurance_sets": "Set 1",
19 "origin_data": "OD-2398273424",
20 "origin_id": "ABC123"
21 }
22 ]
23}Responses
Body
entitiesarray
errorsarray
Example Response
1{
2 "entities": [
3 {
4 "id": 311823,
5 "effective_date": "2015-03-03",
6 "enable_expired_insurance_notifications": false,
7 "exempt": false,
8 "expiration_date": "2016-03-02",
9 "info_received": false,
10 "insurance_provider": "GL Insurance Inc.",
11 "insurance_type": "General Liability",
12 "limit": "1000000.0",
13 "notes": "Meets minimum requirements",
14 "policy_number": "12345GL",
15 "status": "compliant",
16 "vendor_id": 2627684,
17 "additional_insured": "John Doe",
18 "division_template": "Template 1",
19 "insurance_sets": "Set 1",
20 "origin_data": "OD-2398273424",
21 "origin_id": "ABC123"
22 }
23 ],
24 "errors": [
25 {
26 "id": 311823,
27 "effective_date": "2015-03-03",
28 "enable_expired_insurance_notifications": false,
29 "exempt": false,
30 "expiration_date": "2016-03-02",
31 "info_received": false,
32 "insurance_provider": "GL Insurance Inc.",
33 "insurance_type": "General Liability",
34 "limit": "1000000.0",
35 "notes": "Meets minimum requirements",
36 "policy_number": "12345GL",
37 "status": "compliant",
38 "vendor_id": 2627684,
39 "additional_insured": "John Doe",
40 "division_template": "Template 1",
41 "insurance_sets": "Set 1",
42 "origin_data": "OD-2398273424",
43 "origin_id": "ABC123",
44 "errors": {
45 "field_name": [
46 "string"
47 ]
48 }
49 }
50 ]
51}GET /rest/v1.0/projects/{project_id}/vendors/{vendor_id}/insurances/{id}
Description
Show detail on the specified Project Vendor Insurance.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
project_idinteger*
Unique identifier for the project.
vendor_idinteger*
Vendor ID
idinteger*
ID
Example Requests
1const request = require('request');
2
3const options = {
4 method: 'GET',
5 url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/vendors/%7Bvendor_id%7D/insurances/%7Bid%7D'
6};
7
8request(options, function (error, response, body) {
9 if (error) throw new Error(error);
10
11 console.log(body);
12});
13Responses
Body
idinteger
ID
effective_datestring(format: date)
Effective date
enable_expired_insurance_notificationsboolean
Enable/Disable expired insurance notifications
exemptboolean
Exempt status
expiration_datestring(format: date)
Expiration date
info_receivedboolean
Information received (or not)
insurance_providerstring
Insurance provider
insurance_typestring
Insurance type
limitstring
Limit
notesstring
Notes
policy_numberstring
Policy number
statusstring
Status
Allowed values:
compliant
compliant_in_progress
expired
non_compliant
non_compliant_in_progress
undecided
unregistered
vendor_idinteger
Vendor ID
additional_insuredstring
Additional Individuals and/or Companies Insured
division_templatestring
Division Template
insurance_setsstring
Insurance Sets
origin_datastring
Origin data
origin_idstring
Origin ID
Example Response
1{
2 "id": 311823,
3 "effective_date": "2015-03-03",
4 "enable_expired_insurance_notifications": false,
5 "exempt": false,
6 "expiration_date": "2016-03-02",
7 "info_received": false,
8 "insurance_provider": "GL Insurance Inc.",
9 "insurance_type": "General Liability",
10 "limit": "1000000.0",
11 "notes": "Meets minimum requirements",
12 "policy_number": "12345GL",
13 "status": "compliant",
14 "vendor_id": 2627684,
15 "additional_insured": "John Doe",
16 "division_template": "Template 1",
17 "insurance_sets": "Set 1",
18 "origin_data": "OD-2398273424",
19 "origin_id": "ABC123"
20}PATCH /rest/v1.0/projects/{project_id}/vendors/{vendor_id}/insurances/{id}
Description
Update the specified Project Vendor Insurance.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
project_idinteger*
Unique identifier for the project.
vendor_idinteger*
Vendor ID
idinteger*
ID
Example Requests
1const request = require('request');
2
3const options = {
4 method: 'PATCH',
5 url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/vendors/%7Bvendor_id%7D/insurances/%7Bid%7D',
6 headers: {'content-type': 'application/json'},
7 body: {
8 insurance: {
9 effective_date: '2015-03-03',
10 enable_expired_insurance_notifications: true,
11 exempt: false,
12 expiration_date: '2016-03-02',
13 info_received: false,
14 insurance_type: 'General Liability',
15 limit: '1000000.00',
16 name: 'GL Insurance Inc.',
17 notes: 'Meets minimum requirements',
18 policy_number: '12345GL',
19 status: 'compliant',
20 additional_insured: 'John Doe',
21 division_template: 'Template 1',
22 insurance_sets: 'Set 1',
23 origin_data: 'OD-2398273424',
24 origin_id: 'ABC123'
25 }
26 },
27 json: true
28};
29
30request(options, function (error, response, body) {
31 if (error) throw new Error(error);
32
33 console.log(body);
34});
35Body Parameters
Body
insuranceobject*
Example Request Body
1{
2 "insurance": {
3 "effective_date": "2015-03-03",
4 "enable_expired_insurance_notifications": true,
5 "exempt": false,
6 "expiration_date": "2016-03-02",
7 "info_received": false,
8 "insurance_type": "General Liability",
9 "limit": "1000000.00",
10 "name": "GL Insurance Inc.",
11 "notes": "Meets minimum requirements",
12 "policy_number": "12345GL",
13 "status": "compliant",
14 "additional_insured": "John Doe",
15 "division_template": "Template 1",
16 "insurance_sets": "Set 1",
17 "origin_data": "OD-2398273424",
18 "origin_id": "ABC123"
19 }
20}Responses
Body
idinteger
ID
effective_datestring(format: date)
Effective date
enable_expired_insurance_notificationsboolean
Enable/Disable expired insurance notifications
exemptboolean
Exempt status
expiration_datestring(format: date)
Expiration date
info_receivedboolean
Information received (or not)
insurance_providerstring
Insurance provider
insurance_typestring
Insurance type
limitstring
Limit
notesstring
Notes
policy_numberstring
Policy number
statusstring
Status
Allowed values:
compliant
compliant_in_progress
expired
non_compliant
non_compliant_in_progress
undecided
unregistered
vendor_idinteger
Vendor ID
additional_insuredstring
Additional Individuals and/or Companies Insured
division_templatestring
Division Template
insurance_setsstring
Insurance Sets
origin_datastring
Origin data
origin_idstring
Origin ID
Example Response
1{
2 "id": 311823,
3 "effective_date": "2015-03-03",
4 "enable_expired_insurance_notifications": false,
5 "exempt": false,
6 "expiration_date": "2016-03-02",
7 "info_received": false,
8 "insurance_provider": "GL Insurance Inc.",
9 "insurance_type": "General Liability",
10 "limit": "1000000.0",
11 "notes": "Meets minimum requirements",
12 "policy_number": "12345GL",
13 "status": "compliant",
14 "vendor_id": 2627684,
15 "additional_insured": "John Doe",
16 "division_template": "Template 1",
17 "insurance_sets": "Set 1",
18 "origin_data": "OD-2398273424",
19 "origin_id": "ABC123"
20}DELETE /rest/v1.0/projects/{project_id}/vendors/{vendor_id}/insurances/{id}
Description
Delete the specified Project Vendor Insurance.
Header Parameters
Procore-Company-Idinteger*
Unique company identifier associated with the Procore User Account.
Path Parameters
project_idinteger*
Unique identifier for the project.
vendor_idinteger*
Vendor ID
idinteger*
ID
Example Requests
1const request = require('request');
2
3const options = {
4 method: 'DELETE',
5 url: 'https://api.procore.com/rest/v1.0/projects/%7Bproject_id%7D/vendors/%7Bvendor_id%7D/insurances/%7Bid%7D'
6};
7
8request(options, function (error, response, body) {
9 if (error) throw new Error(error);
10
11 console.log(body);
12});
13