GET /rest/v2.0/companies/{company_id}/projects/{project_id}/commitment_contracts
Returns a list of Commitment Contracts for a given project.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
String | Yes |
Unique identifier for the project. |
company_id |
String | Yes |
Unique identifier for the company. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
filters[accounting_method] |
String | No |
Filter to unit or amount based contracts Valid values:
|
filters[deleted_at] |
No |
Filter based on the deleted_at time. |
|
filters[created_at] |
No |
Filter based on the created_at time. |
|
filters[include_deleted] |
String | No |
Use 'only' to return only deleted resources. Use 'with' to return deleted and undeleted resources. Valid values:
|
view |
String | No |
Specifies which view (which attributes) of the resource is going to be present in the response. The extended view includes vendor name and custom fields data, while the default view does not. Valid values:
|
filters[status] |
No |
Filter to specific statuses. For Work Order Contracts: Draft, Out For Bid, Out For Signature, Approved, Complete, Terminated, Void. For Purchase Order Contracts: Draft, Processing, Submitted, Partially Received, Received, Approved, Closed. |
|
page |
Integer | No |
Page |
filters[type] |
String | No |
Filter based on what type of commitment contract it is. Valid values:
|
filters[executed] |
Boolean | No |
Filter based on whether a contract is executed. |
filters[id] |
No |
Return item(s) with the specified ID(s). |
|
per_page |
Integer | No |
Elements per page Default value: 10 |
filters[search] |
String | No |
Returns item(s) matching the specified search query string. |
filters[signature_required] |
Boolean | No |
Filter based on whether a signature is required. |
filters[updated_at] |
No |
Filter based on the updated_at time. |
|
filters[vendor_id] |
No |
Return item(s) with the specified Vendor ID(s). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.