GET /rest/v1.0/work_order_contracts

Return a list of all Work Order Contracts of a specified Project.

See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Servers

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
page Integer No

Page

project_id Integer Yes

Unique identifier for the project.

filters[id][] Array No

Return item(s) with the specified IDs.

filters[origin_id] String No

Origin ID. Returns item(s) with the specified Origin ID.

per_page Integer No

Elements per page

filters[created_at] String No

Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset

filters[updated_at] String No

Return item(s) last updated within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00 - Datetime with Custom Offset

filters[include_deleted] String No

Use 'only' for only deleted resources. Use 'with' for deleted and undeleted resources.

Possible values:

  • "only"
  • "with"
view String No

Specifies how much information to show for each work order contract. The compact view is returned by default.

Possible values:

  • "extended"
  • "compact"
filters[status] String No

Return item(s) with the specified Work Order Contract status.

Possible values:

  • "Draft"
  • "Approved"
  • "Complete"
  • "Out For Bid"
  • "Void"
  • "Out For Signature"
  • "Terminated"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.