GET /rest/v2.1/companies/{company_id}/projects/{project_id}/equipment_register

Get equipment by project (Project)

Servers

Path parameters

Name Type Required Description
project_id String Yes

The Id of 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[model] String No

Model filter

filters[ownership] String No

Ownership filter

sort String No

Equipment sort. Also supports custom field sorting like 'custom_field_123' or '-custom_field_123' for descending

Valid values:

  • "make"
  • "equipmentId"
  • "model"
  • "serialNumber"
  • "type"
  • "equipmentName"
  • "rentalStartDate"
  • "rentalEndDate"
  • "ratePerHour"
  • "category"
  • "notes"
  • "year"
  • "ownership"
search String No

Search criteria applied on name, identification number and serial number

filters[association_status] String No

The status of association. Values can be 'current', 'past' or 'all'. Default is 'current'

Valid values:

  • "past"
  • "current"
  • "all"

Default value: "current"

filters[category_ids] String No

Category filter by Ids

filters[make_ids] String No

Make filter by Ids

filters[assignee_ids] String No

Assignee filter

filters[vendor_ids] String No

Vendor filter

filters[status] String No

Status filter

view String No

Equipment view type

Valid values:

  • "normal"
  • "short"
  • "compact"
  • "ids"

Default value: "normal"

page Integer No

The page number to retrieve. Default is 1.

filters[type] String No

Type filter

filters[year] String No

Year filter

filters[id] String No

Filter ids

filters[is_current_project] String No

Flag to filter by current project

per_page Integer Yes

Number of records per page

Default value: 10

filters[model_ids] String No

Model filter by Ids

filters[category] String No

Category filter

filters[type_ids] String No

Type filter by Ids

filters[make] String No

Make filter

filters[group_ids] String No

Group filter

filters[updated_at] String No

Updated at filter (date range format: YYYY-MM-DD...YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ)

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.