GET /rest/v2.0/companies/{company_id}/workflows/instances
Returns a list of workflow instances for a given company.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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[tool_type] |
String | Yes |
Filter instances with matching tool type. |
per_page |
Integer | No |
Elements per page Default value: 10 |
filters[assignee_id] |
String | No |
Filter item(s) with matching current assignee. |
filters[tool_subtype] |
Integer | No |
Filter instances by tool subtype. Required when tool_type is 'correspondence'. |
filters[item_id] |
String | No |
Filter instances with matching item id. |
filters[active] |
Boolean | No |
Return only items that are active. |
cursor |
String | No |
Cursor location where the returned list of items are before or after this cursor location. |
filters[overdue] |
Boolean | No |
Return only items whose next workflow step is overdue. |
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.