List Prime Contracts
list_prime_contractsRead-onlyIdempotent
Retrieve a paginated list of prime contracts for a project. Use filters like status, vendor, or executed to narrow results.
Instructions
Returns a list of Prime Contracts for a given project. Use this to enumerate Prime Contracts when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Prime Contracts. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id, project_id. Procore API (v2.0): Construction Financials > Prime Contracts. Endpoint: GET /rest/v2.0/companies/{company_id}/projects/{project_id}/prime_contracts
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| view | No | Query string parameter — specifies which view (which attributes) of the resource is going to be present in the response. The extended view includes architect name, contractor name, vendor name and custom fields data, whil... | |
| filters__accounting_method | No | Query string parameter — filter to unit or amount based contracts | |
| filters__architect_id | No | Query string parameter — return item(s) with the specified Architect ID(s). These are Login Information IDs. | |
| filters__contractor_id | No | Query string parameter — return item(s) with the specified Contractor ID(s). These are Vendor IDs. | |
| filters__created_at | No | Query string parameter — filter based on the created_at time. | |
| filters__deleted_at | No | Query string parameter — filter based on the deleted_at time. | |
| filters__id | No | Query string parameter — return item(s) with the specified ID(s). | |
| filters__signature_required | No | Query string parameter — filter based on whether a signature is required. | |
| filters__status | No | Query string parameter — 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, Part... | |
| filters__updated_at | No | Query string parameter — filter based on the updated_at time. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor ID(s). | |
| filters__executed | No | Query string parameter — filter based on whether a contract is executed. |