共用方式為


Fluid Kinnectorz for Procore (Preview)

The Fluid Kinnectorz for Procore connector is a low-code integration application for Procore users. With this connector you can effortlessly create and implement custom workflows by integrating Procore with hundreds of other software packages represented within the Microsoft Power Platform connector library. Choose Phoenix Innovation Lab's Fluid Kinnectorz for Procore - because in construction, you don't have time for anything less!

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Phoenix Innovation Lab Support
URL https://www.phoenixinnovationlab.com/support
Email support@phoenixinnovationlab.com
Connector Metadata
Publisher Phoenix Innovation Lab
Website https://phoenixinnovationlab.com/
Privacy policy https://www.phoenixinnovationlab.com/privacy-policy
Categories Business Management;Productivity

Prerequisites

To use this connector you will need to:

  1. Have a paid account with Procore.

  2. Have a paid work or school account and administrator privileges with either of Microsoft’s Power Automate, Power Apps, or Azure Logic Apps platforms. Note that if you have a Microsoft 365 paid subscription, you may already have access to one or more of these platforms.

  3. Have a Fluid Kinnectorz for Procore paid subscription or free trial from Phoenix Innovation Lab.

How to get credentials

Visit Product Page to purchase a subscription or sign up for a free trial. Click here for a step-by-step guide on how to set up your account.

The connector uses the Procore OAuth credentials to authorize the user and automatically detects a valid subscription based on the Power Automate Environment Id you link to your Phoenix Innovation Lab account. You don't need to explicitly configure any license keys.

Getting started with your connector

As mentioned above, you don't need to configure anything in your Power Automate Environment. Just choose the Fluid Kinnectorz for Procore connector and create your workflows. You will be notified in the flow output if your tenant linking has failed or if your subscription plan has exhausted the API usage limits.

Click here for a step-by-step guide on how to create a Fluid Kinnectorz for Procore connection in Power Automate, and check out this video for a quick example use case.

Known issues and limitations

  1. The Procore API has its own rate limits limits which will apply towards the use of this connector.

  2. The free trial version of this connector is limited to 100 calls total during the trial period.

  3. Your Microsoft account must be a work or school (not personal) account to use this connector.

Common errors and remedies

This connector leverages Procore's API from behind the scenes, so if you are receiving any errors from your Actions, please check the Procore API Status page here and check if it's due to a known issue. If you are unsure or unable to verify the cause of the error, please feel free to reach out to our wonderful support team!

FAQ

Head over to our website and check out our FAQs.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Fluid Kinnectorz Subscription Key securestring Fluid Kinnectorz Subscription Key True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Calendar Events - Get Calendar Events

Get all Calendar Events

Companies - Get Companies

Get list of Companies visible to the User.

Company: Update Project Location

Update Project Location

Coordination Issue Change History - Get Change History

This endpoint returns the change history for the specified Coordination Issue. The change history is sorted by most recent first.

Coordination Issue Counts - Show Grouped Coordination Issue Counts

Get the status counts for Coordination Issues in a project. The counts provide information about how the issues are distributed by location and assignee company.

Coordination Issue Export - Download Project Coordination Issues

Downloads coordination issues to a file specified by the export format.

Coordination Issue File - Show Coordination Issue File

Get a single Coordination Issue File item

Coordination Issue Potential Assignees - Get Potential Assignees

Lists potential assignees for Coordination Issues. Users who are admin or standard users can be assigned to a Coordination Issue

Coordination Issue Recycle Bin - Show Coordination Issue In Recycle Bin

Lists all deleted Coordination Issues in the specified project

Coordination Issue Status Totals-Show Total Status Count For Coordination Issue

Get the status counts for Coordination Issues in a project.

Coordination Issue Sync - Sync Action For Coordinate Issues

This endpoint is used to create and update a batch of CoordinationIssues. See Using Sync Actions for additional information.

Coordination Issues - Delete association

Delete the association between Coordination Issue and Procore item

Coordination Issues - Delete Coordination Issue

Delete a Coordination Issue from the system

Coordination Issues - Get Coordination Issues

Lists Coordination Issues associated with the specified Project.

Coordination Issues - Show Coordination Issue

Return a single Coordination Issue item.

Delete Bid Type

Delete Bid Type

Delete Department

Delete Department

Delete Project File

Delete Project File

Delete Project Folder

Delete Project Folder

Delete Project Owner Type

Delete Project Owner Type

Delete Project Region

Delete Project Region

Delete Project Stage

Delete Project Stage

Delete Project Type

Delete Project Type

Delete Project User

Delete Project User

Drawings - Delete Drawing Set

Delete a specified Drawing Set.

Drawings - Delete Drawing Upload

Delete an unreviewed Drawing Upload.

Drawings - Get Drawing Areas

Get all Drawing Areas

Drawings - GetDrawings

Get all drawings for a specified drawing area.

Drawings - List Drawing Revisions

Get list of all Drawing Revisions in the specified Project.

Drawings - List Drawing Sets

Get Drawing Sets in the specified Project.

Drawings - List Drawing Tiles

Lists the Drawing Tiles in the specified Drawing Revision along with the maximum Zoom Level and Tile Size.

Drawings - List Drawing Uploads

Get list of all Drawing Uploads in the specified Project.

Drawings - Update Drawing

Update specified Drawing

Drawings-Update Drawing Set

Update an existing Drawing Set in the specified Project.

Filter Options - Get Filter Options

Get list of filter fields and options for RFIs on a specified Project

Filter Options - List Available RFI Assigned_id Filter Options

Get a list of assigned_id filter fields and options for RFIs on a specified Project

Filter Options - List Available RFI Ball In Court Filter Options

Get a list of available RFI ball in court filter fields and options for RFIs on a specified Project

Filter Options - List Available RFI Cost Code Options

Get a list of RFI cost code options for a specified Project

Filter Options - List Available RFI Manager Filter Options

Get a list of available RFI Manager filter fields and options for RFIs on a specified Project

Filter Options - List Available RFI Received From Filter Options

Get a list of received from filter options for RFIs on a specified Project

Filter Options - List Available RFI Responsible Contractor Filter Options

Get a list of responsible contractor filter fields and options for RFIs on a specified Project

Filter Options - List Available RFI Status Filter Options

Get a list of status filter fields and options for RFIs on a specified Project

Filter Options - List Available RFIs Locations

Get a list of RFI locations for a specified Project

Get a Specific Version of a File

Get a Specific Version of a File

Get Bid Type

Get Bid Type Details

Get Bid Types

Get Bid Types

Get Company Current User

Get Company Current User

Get Company Inactive Users

Get In-Active Company Users

Get Company Permission Templates

Get Company Permission Templates

Get Company User

Show detail on a specified User

Get Company Users

Get Company Users

Get Coordinate Issues in Recycle Bin

Lists all deleted Coordination Issues in the specified project

Get Department by Id

Get Department by Id

Get Departments

Get Departments

Get Distribution Members

Get Distribution Members

Get FileContent By Url

Get FileContent for a given URL

Get My Profile

Get Current User Info

Get Project File

Get Project File

Get Project Files

Get Project Files

Get Project Inactive Users

Get In-Active Project Users

Get Project Owner Type

Get Project Owner Type Details

Get Project Owner Types

Get Project Owner Types

Get Project Permission Template

Get Project Permission Templates

Get Project Region

Get Project Region Details

Get Project Regions

Get Project Regions

Get Project Stage

Get Project Stage Details

Get Project Stages

Get Project Stages

Get Project Type

Get Project Type Details

Get Project Types

Get Project Types

Get Project User

Get Project User Info

Get Project Users

Get Project Users

Get RFI Distribution List

Get RFI Distribution List

Image Categories - Delete Image Category

Delete a Photo Album (Image Category) from a specified Project.

Image Categories - Get Image Categories

Return a list of all Photo Albums (Image Categories) in a specified project

Image Categories - List Image Category IDs That Contain Images

Return an array of Image Category IDs for a specified Project that contain Images

Image Categories - Show Image Category

Return detail information about the specified Photo Album (Image Category).

Image Categories - Update Image Category

Update a Photo Album (Image Category) in a specified Project.

Images - Delete Image

Remove an Image from a Project.

Images - Get Images

Return a list of all Images from a Project's Photo Album (Image Category).

Images - Show Image

Show detailed information for a specified Image in a Project's Photo Album (Image Category).

Images - Update Image

Update Image

Instruction Types - Delete Instruction Type

Delete the specified Instruction Type.

Instruction Types - Get Instruction Types

Return a list of all Instruction Types from a specified Project.

Instruction Types - Show Instruction Type

Get detailed information on the specified Instruction Type.

Instruction Types - Update Instruction Type

Update the specified Instruction Type.

Instructions - Delete Instruction

Delete the specified Instruction.

Instructions - Get Instructions

Return a list of all Instructions from a specified Project.

Instructions - Show Instruction

Get detailed information on the specified Instruction.

Instructions - Update Instruction

Update the specified Instruction.

List files in folder by Project Id

List files in a Procore Project folder

Meetings - Delete Meeting

Delete a specified meeting from the system

Meetings - Delete Meeting Attendee Record

Delete a specified meeting attendee record, disassociating a given user from a meeting

Meetings - Get Meetings

Get list of all Meetings for a specified Project.

Meetings - List Ecrion Xml And Template For Meetings

Returns Ecrion Xml and Template for all Meetings on the Project.

Meetings - List Meeting Categories

Get all Meeting Categories for a given Meeting.

Meetings - Show Meeting

Returns detailed information about a Meeting in a specified Project.

Meetings - Update Meeting

Update a Meeting.

Meetings - Update Meeting Attendee Record

Update a Meeting Attendee record.

Meetings - Update Meeting Category

Update a Meeting Category.

Meetings - Update Meeting Topic

Update an existing Meeting Topic.

Potential Managers - List Of Possible Managers

Get all potential Managers for an RFI.

Programs - Get Programs

Return a list of Programs associated to the specified Company.

Project Admin Equipment - GetProjectEquipment

Return a list of all Project Equipment.

Project Folders And Files - Get Folders and Files

Get list of Folders and Files for a specified Project.

Project Root Folders

Get Root Folders

Project: Delete Project Location

Delete Project Location

Project: Get Location

Get Project Location Details

Project: Get Locations

Get Project Locations

Projects - Get Projects

Return a list of active Projects.

Projects - Show Project

Show details of the specified Project in Procore.

Projects - Sync Projects

Create or update a batch of Projects.

Projects - Update Project

Update an existing Project's information.

Replies - Delete An RFI Response

Deletes a specified response associated with a specified RFI and specified Project

Replies - Get Replies

Get list of replies for a specified RFI

Replies - Show RFI Reply

Get detailed information on a specified RFI reply

Replies - Update RFI Reply

Updates a specified RFI reply

Resources - Delete Resource

Delete the specified Resource. Note that when a resource is deleted, any assignments to tasks will also be removed.

Resources - Get Resources

Get list of all resources in a specified Project

Resources - Show Resource

Show detail on the specified Resource.

Resources - Update Resource

Update the specified Resource.

RFI - List Of Possible Assignees

Get all potential Assignees for an RFI

RFIs - Get RFIs

Get all RFIs in a specified Project.

RFIs - List Recycled RFIs

Get all deleted RFIs in a specified Project

RFIs - Recycle RFI

Send a specified RFI to the Recycle Bin.

RFIs - Retrieve Recycled RFI

Get a specified RFI from the Recycle Bin.

RFIs - Show RFI

Get detailed information about a specified RFI in a specified Project.

RFIs - Update RFI

Updates a specified RFI in a specified Project.

Schedule - Get Requested Changes

Get all Requested Changes of a Task.

Send User Invite

Send User Invite

Sync Company Users

Sync Company Users

Task Items - Get Tasks Items

Get Tasks Items

Tasks - Delete Task

Delete the specified Task.

Tasks - List Tasks

List existing tasks for the specified Project.

Tasks - Sync Tasks

This endpoint creates or updates a batch of tasks.

Timecard Entries - Delete Timecard Entry

Delete a specified Timecard Entry.

Timecard Entries - Get Timecard Entries

Get all Time Card Entries

ToDos - Delete Todo

Delete a specific ToDo Item in a specified Project.

ToDos - Show Todo

Return detailed information about a ToDo Item in a specified Project.

ToDos - Update Todo

Update a ToDo item for a specified Project.

Update Company User

Update Company User

Update Department

Update Department

Update Project File

Update Project File

Update Project Folder

Update Project Folder

Update Project Owner Type

Update Project Owner Type

Update Project Region

Update Project Region

Update Project Stage

Update Project Stage

Update Project Type

Update Project Type

Update Project User

Update Project User

Calendar Events - Get Calendar Events

Get all Calendar Events

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Start Date (eg 2020-07-16T19:20:30.45+01:00)
calendar[start_datetime] date-time

Start Date

Finish Date (eg 2020-07-16T19:20:30.45+01:00)
calendar[finish_datetime] date-time

Finish date or date-time

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Companies - Get Companies

Get list of Companies visible to the User.

Parameters

Name Key Required Type Description
Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Company: Update Project Location

Update Project Location

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Location ID
id True integer

ID of the location

Node Name
node_name string

Node Name of the Location

Parent ID
parent_id integer

ID of the Parent Location of the Location

Returns

The outputs of this operation are dynamic.

Coordination Issue Change History - Get Change History

This endpoint returns the change history for the specified Coordination Issue. The change history is sorted by most recent first.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Coordination Issue ID
id True integer

Coordination Issue ID

View
view string

Specify View of Result

Returns

The outputs of this operation are dynamic.

Coordination Issue Counts - Show Grouped Coordination Issue Counts

Get the status counts for Coordination Issues in a project. The counts provide information about how the issues are distributed by location and assignee company.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Group By
filters[group_by] string

Filter status counts by selected attribute

Returns

The outputs of this operation are dynamic.

Coordination Issue Export - Download Project Coordination Issues

Downloads coordination issues to a file specified by the export format.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Assignee Company ID
filters[assignee_company_id] integer

Filter item(s) with matching assignee vendor companies

Assignee ID
filters[assignee_id] integer

Filter item(s) with matching assignees

Coordination Issue ID
filters[ids] integer

Filter item(s) with matching ids

Location ID
filters[location_id] integer

Filter item(s) with matching locations

Search Query
filters[search] string

Filter item(s) with the matching search query. The search is performed on title and issue number

Coordination Issue File ID
filters[coordination_issue_file_id] string

Filter item(s) with the exact coordination issue file

Status
filters[status] string

Filter item(s) with matching status

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Sort
sort string

Sort item(s) by an attribute. The default sort is ascending. To sort in descending order, prepend the sort value with a hyphen character '-'

Export Format
export_format string

Export File Format

Returns

The outputs of this operation are dynamic.

Coordination Issue File - Show Coordination Issue File

Get a single Coordination Issue File item

Parameters

Name Key Required Type Description
ID
id True integer

ProCore Coordination Issue File ID or UUID

Name
name integer

Name of coordination issue file

Response View
view string

Compact view contains only ids. The normal and extended view contains the response shown below

Returns

The outputs of this operation are dynamic.

Coordination Issue Potential Assignees - Get Potential Assignees

Lists potential assignees for Coordination Issues. Users who are admin or standard users can be assigned to a Coordination Issue

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Coordination Issue Recycle Bin - Show Coordination Issue In Recycle Bin

Lists all deleted Coordination Issues in the specified project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Coordination Issue ID
id True integer

Coordination Issue ID

View
view string

View Type

Returns

The outputs of this operation are dynamic.

Coordination Issue Status Totals-Show Total Status Count For Coordination Issue

Get the status counts for Coordination Issues in a project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Coordination Issue Sync - Sync Action For Coordinate Issues

This endpoint is used to create and update a batch of CoordinationIssues. See Using Sync Actions for additional information.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

UUID
uuid string

Coordination Issue UUID (This is an optional parameter, and is set automatically on server if not present in the payload)

Title
title True string

Coordination Issue title.The title can have a maximum of 80 characters

Description
description string

Coordination Issue description

Status
status string

Status of the issue. Should be either open or closed

Creation Source
creation_source string

Source of issue creation. This attribute is ignored when issue is create by third party developers

Location ID
location_id integer

Location where the issue is present. The location must be in the same project as the Project ID

Assignee ID
assignee_id integer

ID of Procore user that should be assigned the issue

File ID
coordination_issue_file_id integer

ID of the BIM File to be set as origin source

BIM Model ID
bim_model_id integer

ID of the model to be associated

Due date
due_date string

Due date of the Coordination Issue

Origin Title
title True string

Title of the origin item

Origin ID
origin_id True string

Id of the origin item

Origin Type
origin_type True string

Type of origin item

Deep link URL
deep_link_url True string

Deep link URL to the origin item

File Name
filename string

The Name of the File to be created with extension

File Content
documentContent byte

File Content

Content Type
contentType string

Content Type - Optional

Attachments
attachments array of string

Array of Attachments

Snapshot Upload UUID
snapshot_upload_uuid string

UUID of uploaded snapshot

Snapshot
snapshot string

File to use as image data

Name
name string

Viewpoint name

Camera Data
camera_data object

Camera data for the building model associated with the issue

Redlines Data
redlines_data string

Lines data for the building model associated with the issue

Section Data
sections_data string

Clipping plane data for the building model associated with the issue

Returns

The outputs of this operation are dynamic.

Coordination Issues - Delete association

Delete the association between Coordination Issue and Procore item

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Coordination Issue ID
coordination_issue_id True integer

Coordination Issue ID

RFI ID
id True integer

RFI ID

Returns

response
object

Coordination Issues - Delete Coordination Issue

Delete a Coordination Issue from the system

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Coordination Issue ID
id True integer

Coordination Issue ID

Returns

response
object

Coordination Issues - Get Coordination Issues

Lists Coordination Issues associated with the specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Filter by Assignee Company ID
filters[assignee_company_id] integer

Filter item(s) with matching assignee vendor companies

Filter by Assignee ID
filters[assignee_id] integer

Filter item(s) with matching assignees

Filter by matching ID
filters[ids] integer

Filter item(s) with matching ids

Filter by location ID
filters[location_id] integer

Filter item(s) with matching locations

Filter by sub location ID
filters[include_sublocations] boolean

Use together with filters[location_id]

Filter by matching search query
filters[search] string

Filter item(s) with the matching search query. The search is performed on title and issue number

Filter by Coordination Isssue File ID
filters[coordination_issue_file_id] string

Filter item(s) with the exact coordination issue file

Filter by matching Status
filters[status] string

Filter item(s) with matching status

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Sort Data by
sort string

Sort item(s) by an attribute. The default sort is ascending. To sort in descending order, prepend the sort value with a hyphen character '-'

View
view string

View Type

Save Sticky Filters
save_sticky_filters string

Persists filter parameters for the requesting user and project

Returns

The outputs of this operation are dynamic.

Coordination Issues - Show Coordination Issue

Return a single Coordination Issue item.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Coordination Issue ID
id True integer

Coordination Issue ID

View
view string

The compact view contains only ids. The normal view is a subset of the response shown below, and does not include attachments, viewpoints, linked items and updated_by The extended view contains the response shown below

Returns

The outputs of this operation are dynamic.

Delete Bid Type

Delete Bid Type

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Bid Type ID
id True integer

Project Bid Type ID

Returns

response
object

Delete Department

Delete Department

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Department ID
id True integer

Department ID

Returns

response
object

Delete Project File

Delete Project File

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

File ID
file_id True integer

Project File Id

Returns

response
object

Delete Project Folder

Delete Project Folder

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

Returns

response
object

Delete Project Owner Type

Delete Project Owner Type

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Owner Type ID
id True integer

Project Owner Type ID

Returns

response
object

Delete Project Region

Delete Project Region

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Region ID
id True integer

Project Region ID

Returns

response
object

Delete Project Stage

Delete Project Stage

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Stage ID
id True integer

Project Stage ID

Returns

response
object

Delete Project Type

Delete Project Type

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Type ID
id True integer

Project Type ID

Returns

response
object

Delete Project User

Delete Project User

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

User ID
id True integer

User ID

Returns

response
object

Drawings - Delete Drawing Set

Delete a specified Drawing Set.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

ID
id True integer

ID of the drawing set

Returns

response
object

Drawings - Delete Drawing Upload

Delete an unreviewed Drawing Upload.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Drawing Upload ID
id True integer

ID of the drawing upload

Returns

response
object

Drawings - Get Drawing Areas

Get all Drawing Areas

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Drawings - GetDrawings

Get all drawings for a specified drawing area.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Drawing Area ID
drawing_area_id True integer

ID of the drawing area

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Drawings - List Drawing Revisions

Get list of all Drawing Revisions in the specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Drawing Area ID
drawing_area_id integer

Filter by Drawing Area

Drawing ID
drawing_id integer

Filter by Drawing

Discipline ID
drawing_discipline_id integer

Filter by Drawing Discipline

Drawing Set ID
drawing_set_id integer

Filter by Drawing Set

Drawing Revision ID
id integer

Filter by Drawing Revision ID To request specific drawing revision ids

Drawing Revision IDs
filters[ids] integer

Filter by Drawing Revisions ID To request specific drawing revision ids

Is Reviewed
is_reviewed boolean

Filter by reviewed status

Query
query string

Filter by custom query

Is Obsolete
with_obsolete boolean

Include obsolete drawing revisions. Obsolete drawing revisions are filtered by default.

Returns

The outputs of this operation are dynamic.

Drawings - List Drawing Sets

Get Drawing Sets in the specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Filter by Exclude Empty Sets
filters[exclude_empty_sets] boolean

Return set(s) that contain at least one drawing

Returns

The outputs of this operation are dynamic.

Drawings - List Drawing Tiles

Lists the Drawing Tiles in the specified Drawing Revision along with the maximum Zoom Level and Tile Size.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Drawing Revision ID
drawing_revision_id True integer

ID of the drawing revision

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Drawings - List Drawing Uploads

Get list of all Drawing Uploads in the specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Drawings - Update Drawing

Update specified Drawing

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Drawing Area ID
drawing_area_id True integer

ID of the drawing area

Drawing ID
id True integer

Drawing ID

Number
number string

Drawing number

Title
title string

Drawing title

Obsolete
obsolete boolean

Obsolete status

Name
name string

Drawing discipline name

Ordered Revision IDs
ordered_revision_ids array of integer

Ordered array of the complete list of reviewed and published Drawing Revision IDs that belong to the drawing

Returns

The outputs of this operation are dynamic.

Drawings-Update Drawing Set

Update an existing Drawing Set in the specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Drawing Set ID
id True integer

ID of the drawing set

Name
name string

Drawing Set name

Date
date string

Drawing Set date

Returns

The outputs of this operation are dynamic.

Filter Options - Get Filter Options

Get list of filter fields and options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Assigned_id Filter Options

Get a list of assigned_id filter fields and options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Ball In Court Filter Options

Get a list of available RFI ball in court filter fields and options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Cost Code Options

Get a list of RFI cost code options for a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Manager Filter Options

Get a list of available RFI Manager filter fields and options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Received From Filter Options

Get a list of received from filter options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Responsible Contractor Filter Options

Get a list of responsible contractor filter fields and options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFI Status Filter Options

Get a list of status filter fields and options for RFIs on a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Filter Options - List Available RFIs Locations

Get a list of RFI locations for a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Get a Specific Version of a File

Get a Specific Version of a File

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

File ID
file_id True integer

Project File Id

File Version ID
version_id True integer

Project File Version Id

Returns

The outputs of this operation are dynamic.

Get Bid Type

Get Bid Type Details

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Bid Type ID
id True integer

Project Bid Type ID

Returns

The outputs of this operation are dynamic.

Get Bid Types

Get Bid Types

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Get Company Current User

Get Company Current User

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Returns

The outputs of this operation are dynamic.

Get Company Inactive Users

Get In-Active Company Users

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Get Company Permission Templates

Get Company Permission Templates

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Returns

The outputs of this operation are dynamic.

Get Company User

Show detail on a specified User

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

User ID
id True integer

User ID

Returns

The outputs of this operation are dynamic.

Get Company Users

Get Company Users

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Created Date
filters[created_at] string

Filter based on created date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Returns

The outputs of this operation are dynamic.

Get Coordinate Issues in Recycle Bin

Lists all deleted Coordination Issues in the specified project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Filter by Assignee Company ID
filters[assignee_company_id] integer

Filter item(s) with matching assignee vendor companies

Filter by Assignee ID
filters[assignee_id] integer

Filter item(s) with matching assignees

Filter by matching ID
filters[ids] integer

Filter item(s) with matching ids

Filter by location ID
filters[location_id] integer

Filter item(s) with matching locations

Filter by sub location ID
filters[include_sublocations] boolean

Filter by sub location ID

Filter by matching search query
filters[search] string

Filter item(s) with the matching search query. The search is performed on title and issue number

Filter by Coordination Isssue File ID
filters[coordination_issue_file_id] string

Filter item(s) with the exact coordination issue file

Filter by matching Status
filters[status] string

Filter by matching Status

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Sort Data by
sort string

Sort item(s) by an attribute. The default sort is ascending. To sort in descending order, prepend the sort value with a hyphen character '-'

View
view string

View Type

Returns

The outputs of this operation are dynamic.

Get Department by Id

Get Department by Id

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

ID
id True integer

Department ID

Returns

The outputs of this operation are dynamic.

Get Departments

Get Departments

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Get Distribution Members

Get Distribution Members

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Get FileContent By Url

Get FileContent for a given URL

Parameters

Name Key Required Type Description
File URL
url True string

URL location of the file you would like to get contents for

File Name
filename string

Name you would like to assign to file

Returns

The outputs of this operation are dynamic.

Get My Profile

Get Current User Info

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Get Project File

Get Project File

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

File ID
file_id True integer

Project File Id

Returns

The outputs of this operation are dynamic.

Get Project Files

Get Project Files

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

Returns

The outputs of this operation are dynamic.

Get Project Inactive Users

Get In-Active Project Users

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Get Project Owner Type

Get Project Owner Type Details

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Owner Type ID
id True integer

Project Owner Type ID

Returns

The outputs of this operation are dynamic.

Get Project Owner Types

Get Project Owner Types

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Limit Records
per_page integer

Limit to Number of Records in the response

Page No
page integer

Page number for which you want to retrieve the data

Returns

The outputs of this operation are dynamic.

Get Project Permission Template

Get Project Permission Templates

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Get Project Region

Get Project Region Details

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Region ID
id True integer

Project Region ID

Returns

The outputs of this operation are dynamic.

Get Project Regions

Get Project Regions

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Limit Records
per_page integer

Limit to Number of Records in the response

Page No
page integer

Page number for which you want to retrieve the data

Returns

The outputs of this operation are dynamic.

Get Project Stage

Get Project Stage Details

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Stage ID
id True integer

Project Stage ID

Returns

The outputs of this operation are dynamic.

Get Project Stages

Get Project Stages

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Limit Records
per_page integer

Limit to Number of Records in the response

Page No
page integer

Page number for which you want to retrieve the data

Returns

The outputs of this operation are dynamic.

Get Project Type

Get Project Type Details

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Type ID
id True integer

Project Type ID

Returns

The outputs of this operation are dynamic.

Get Project Types

Get Project Types

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Record
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Get Project User

Get Project User Info

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

User ID
id True integer

User ID

Returns

The outputs of this operation are dynamic.

Get Project Users

Get Project Users

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Created Date
filters[created_at] string

Filter based on created date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Returns

The outputs of this operation are dynamic.

Get RFI Distribution List

Get RFI Distribution List

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Image Categories - Delete Image Category

Delete a Photo Album (Image Category) from a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image Category ID
id True integer

ID of the image category

Returns

response
object

Image Categories - Get Image Categories

Return a list of all Photo Albums (Image Categories) in a specified project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Image Categories - List Image Category IDs That Contain Images

Return an array of Image Category IDs for a specified Project that contain Images

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Returns

The outputs of this operation are dynamic.

Image Categories - Show Image Category

Return detail information about the specified Photo Album (Image Category).

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image Category ID
id True integer

ID of the image category

Returns

The outputs of this operation are dynamic.

Image Categories - Update Image Category

Update a Photo Album (Image Category) in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image Category ID
id True integer

ID of the image category

Image Category
name True string

Name of the Image Category

Is Private
private boolean

Private status of the Image Category

Album Cover ID
album_cover_id integer

ID of an Image that is the cover Image of the Image Category

Returns

The outputs of this operation are dynamic.

Images - Delete Image

Remove an Image from a Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image ID
id True integer

ID of the image

Returns

response
object

Images - Get Images

Return a list of all Images from a Project's Photo Album (Image Category).

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image Category ID
image_category_id integer

ID of the image category to filter the images by

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Log Date
filters[log_date] string

Date of specific logs desired in YYYY-MM-DD format

Is Private
filters[private] boolean

If true, only return item(s) with a private status

Is Starred
filters[starred] boolean

If true, return items with a starred status

Specific Location ID
filters[location_id] integer

Filters by specific location (Note: Use either this or location_id_with_sublocations, but not both)

Is Sub locations
filters[include_sublocations] boolean

Use together with filters[location_id]

Trade IDs
filters[trade_ids] integer

Return item(s) with the specified Trade ID

Search Query
filters[query] string

Return item(s) containing the specified search query

Created Date
filters[created_at] string

Filter based on created date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Specific IDs
filters[id] string

Return item(s) with the specified IDs

Sort By
sort string

Field to sort by

Serializer View
serializer_view string

Data set that should be returned from the serializer.The normal view includes default fields, plus links, comments_count, trades. The android view includes default fields, plus trades, comments. The mobile view include default fields, plus log_date, trades, comments. The mobile_feed view includes default fields, plus comments. The prostore_file view includes default fields, plus images. The ids_only view does not include default fields, response returns strictly an array of image ids. Default view is normal.

Returns

The outputs of this operation are dynamic.

Images - Show Image

Show detailed information for a specified Image in a Project's Photo Album (Image Category).

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image ID
id True integer

ID of the image

Returns

The outputs of this operation are dynamic.

Images - Update Image

Update Image

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Image ID
id True integer

ID of the image

Is Private
private boolean

Private status of the Image

Description
description string

Image description

Image Category ID
image_category_id integer

Image Category ID to move the Image to

Location ID
location_id integer

If you want to use an existing location and you have the ID of that existing location use this. location_id takes precedence over mt_location

mt_location
mt_location array of string

mt_location

trade_ids
trade_ids array of integer

trade_ids

Log Date
log_date string

Log Date of the Image

Returns

The outputs of this operation are dynamic.

Instruction Types - Delete Instruction Type

Delete the specified Instruction Type.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Instruction ID
id True integer

Instruction ID

Returns

response
object

Instruction Types - Get Instruction Types

Return a list of all Instruction Types from a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Instruction Types - Show Instruction Type

Get detailed information on the specified Instruction Type.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Instruction ID
id True integer

Instruction ID

Returns

The outputs of this operation are dynamic.

Instruction Types - Update Instruction Type

Update the specified Instruction Type.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Instruction ID
id True integer

Instruction ID

Name
name True string

Name of Instruction Type

Returns

The outputs of this operation are dynamic.

Instructions - Delete Instruction

Delete the specified Instruction.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Instruction ID
id True integer

Instruction ID

Returns

response
object

Instructions - Get Instructions

Return a list of all Instructions from a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Instructions - Show Instruction

Get detailed information on the specified Instruction.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Instruction ID
id True integer

Instruction ID

Returns

The outputs of this operation are dynamic.

Instructions - Update Instruction

Update the specified Instruction.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Instruction ID
id True integer

Instruction ID

Send Emails
send_emails boolean

Designates whether or not emails will be sent

Number
number string

Number of the Instruction

Title
title string

Title of the Instruction

Status
status string

Status of the Instruction

Instruction Type ID
instruction_type_id integer

ID of the Instruction Type

Instruction From ID
instruction_from_id integer

ID of the User who the Instruction is from

Received Date
date_received string

Instruction Received date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Status
status string

Status of the Schedule Impact

Value
value integer

Value in days of the Schedule Impact

Status
status string

Status of the Cost Impact

Value
value float

Cost impact value in dollars

Is Private
private boolean

Private status of the Instruction

Instruction Description
description string

Description of the Instruction

attention_ids
attention_ids array of integer

Array of IDs of the Attentions of the Instruction

distribution_member_ids
distribution_member_ids array of integer

Array of IDs of the Distributions of the Instruction

trade_ids
trade_ids array of integer

Array of IDs of the Trades of the Instruction

File Name
filename string

The Name of the File to be created with extension

File Content
documentContent byte

File Content

Content Type
contentType string

Content Type - Optional

attachments
attachments array of string

attachments

Returns

The outputs of this operation are dynamic.

List files in folder by Project Id

List files in a Procore Project folder

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

Returns

The outputs of this operation are dynamic.

Meetings - Delete Meeting

Delete a specified meeting from the system

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting ID
id True integer

ID of the meeting

Returns

response
object

Meetings - Delete Meeting Attendee Record

Delete a specified meeting attendee record, disassociating a given user from a meeting

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting ID
meeting_id True integer

Meeting ID

Meeting Attendee Record
id True integer

Meeting Attendee Record

Returns

response
object

Meetings - Get Meetings

Get list of all Meetings for a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Meetings - List Ecrion Xml And Template For Meetings

Returns Ecrion Xml and Template for all Meetings on the Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Meetings - List Meeting Categories

Get all Meeting Categories for a given Meeting.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting ID
meeting_id True integer

Meeting ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Meetings - Show Meeting

Returns detailed information about a Meeting in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting ID
id True integer

Meeting ID

Returns

The outputs of this operation are dynamic.

Meetings - Update Meeting

Update a Meeting.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting ID
id True integer

Meeting ID

Position
position integer

Position of the Meeting(Can only be updated if the Meeting is the first Meeting in the series)

Title
title string

Title of the Meeting

Location
location string

Location of the Meeting

Minutes
minutes string

Minutes of the Meeting

Meeting Date
meeting_date string

Date of the Meeting.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Overview
overview string

Description of the Meeting

Is Occurred
occurred boolean

Occurred status of the Meeting

Start Time
start_time string

Start Time of the Meeting

Finish Time
finish_time string

Finish Time of the Meeting

Time Zone
time_zone string

Timezone of the Meeting

Is Private
is_private boolean

Private status of the Meeting

Conclusion
conclusion string

Conclusion of the Meeting

Is Draft
is_draft boolean

Draft status of the Meeting

File Name
filename string

The Name of the File to be created with extension

File Content
documentContent byte

File Content

Content Type
contentType string

Content Type - Optional

Returns

The outputs of this operation are dynamic.

Meetings - Update Meeting Attendee Record

Update a Meeting Attendee record.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting Attendee Record ID
id True integer

ID of the Meeting Attendee record

Meeting ID
meeting_id True integer

ID of the Meeting

Attendance status
status True string

Attendance status

Login Information ID
login_information_id True integer

ID of the User to associate with the Meeting

Returns

The outputs of this operation are dynamic.

Meetings - Update Meeting Category

Update a Meeting Category.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting ID
meeting_id True integer

ID of the Meeting the Meeting Category belongs to

Meeting Category ID
id True integer

ID of the meeting category

Position
position integer

Position of the Meeting Category

Title
title string

Title of the Meeting Category

Returns

The outputs of this operation are dynamic.

Meetings - Update Meeting Topic

Update an existing Meeting Topic.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Meeting Topic ID
id True integer

Meeting Topic ID

Meeting ID
meeting_id True integer

ID of the Meeting the Meeting Topic belongs to

Title
title string

Title of the Meeting Topic

Description
description string

Description of the Meeting Topic

Due Date
due_date string

Due Date of the Meeting Topic

Status
status string

Status of the Meeting Topic

Minutes of the Meeting Topic
minutes string

Minutes of the Meeting Topic

Is Private
is_private boolean

Private status of the Meeting Topic

Date of the Topic closed
closed_at string

Date of the Meeting Topic being closed.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Priority
priority string

Priority of the Meeting Topic

Added Under Agenda status
added_under_agenda boolean

Added Under Agenda status of the Meeting Topic

Wide Number
meeting_wide_number integer

Meeting Wide Number of the Meeting Topic

Meeting Category ID
meeting_category_id integer

ID of the Meeting Category the Meeting Topic belongs to

attachments
attachments array of string

An array of the Attachments of the Meeting Topic

File Name
filename string

The Name of the File to be created with extension

File Content
documentContent byte

File Content

Content Type
contentType string

Content Type - Optional

Returns

The outputs of this operation are dynamic.

Potential Managers - List Of Possible Managers

Get all potential Managers for an RFI.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

Programs - Get Programs

Return a list of Programs associated to the specified Company.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Project Admin Equipment - GetProjectEquipment

Return a list of all Project Equipment.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Project Folders And Files - Get Folders and Files

Get list of Folders and Files for a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Exclude Folders
exclude_folders boolean

Exclude child Folders from results

Exclude Files
exclude_files boolean

Exclude child Files from results

Latest File Version
show_latest_file_version_only boolean

Show only latest File version

Returns

The outputs of this operation are dynamic.

Project Root Folders

Get Root Folders

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Exclude Files
exclude_files boolean

Exclude child Files from results

Returns

The outputs of this operation are dynamic.

Project: Delete Project Location

Delete Project Location

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Location ID
id True integer

ID of the location

Returns

response
object

Project: Get Location

Get Project Location Details

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Location ID
id True integer

ID of the location

Returns

The outputs of this operation are dynamic.

Project: Get Locations

Get Project Locations

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Projects - Get Projects

Return a list of active Projects.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Project Status
filters[by_status] string

Filters on project status

Created Date
filters[created_at] string

Filter based on created date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Project Origin ID
filters[origin_id] string

Project Origin ID

Project IDs
filters[id] string

Project IDs

Synced Status
filters[synced] boolean

Synced Status

Serializer View
serializer_view string

Serializer View

Returns

The outputs of this operation are dynamic.

Projects - Show Project

Show details of the specified Project in Procore.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
id True integer

ID of the project

Returns

The outputs of this operation are dynamic.

Projects - Sync Projects

Create or update a batch of Projects.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Run Configurable Validations
run_configurable_validations boolean

Whether or not Configurable validations from the corresponding Configurable Field Set should be run

Project ID
id integer

ID of the Project

Active status
active boolean

Active status of the Project

Street Address
address string

Street Address of the Project location

City
city string

City in which the Project is located

Country Code
country_code string

Two character Code that represents the Country in which the Project is located (ISO-3166 Alpha-2 format)

Description
description string

Description of the Project

Start Date
start_date string

Date that the contract for the project is signed

Completion Date
completion_date string

Date that all parties agree the project meets or must meet “substantial completion”.

Total Value
total_value string

Total amount of construction work performed, planned, or put in place during the project.

Warranty Start Date
warranty_start_date string

Warranty Start Date of the Project

Warranty End Date
warranty_end_date string

Warranty End Date of the Project

Flag of the Project
flag string

Flag of the Project

Image ID
image_id integer

Image ID of the Project

The Name of the Project
name string

Name of the Project

ID of the Office
office_id integer

ID of the Office of the Project

Phone number
phone string

Phone number of the Project

Number of the Project
project_number string

Number of the Project

Public Notes
public_notes string

Public Notes of the Project

Square Footage
square_feet integer

Square Footage of the Project

State Code
state_code string

Code that represents the State of the Project (ISO-3166 Alpha-2 format)

Timezone
time_zone string

Timezone of the Project

Zip code
zip string

Zip code of the Project

Program ID
program_id integer

Program ID of the Project

Bid Type ID
project_bid_type_id integer

Project Bid Type ID of the Project

Stage ID
project_stage_id integer

Project Stage ID of the Project

Type ID
project_type_id integer

Project Type ID

Owner Type ID
project_owner_type_id integer

Project Owner Type ID of the Project

Region ID of the Project
project_region_id integer

Project Region ID of the Project

Project Template ID
project_template_id integer

Project ID Template as designated by another Project on this company.

Third-party ID
origin_id string

Third-party ID of the Project

Third-party Data
origin_data string

Third-party Data of the Project

department_ids
department_ids array of integer

IDs of the Departments the Project belongs to

Estimated Value
estimated_value string

Estimated Value of the project

Estimated Start Date
estimated_start_date string

Estimated Start Date of the Project.

Estimated Completion Date
estimated_completion_date string

Estimated Completion Date of the Project.

Store Number
store_number string

Store Number of the Project

Accounting Project Number
accounting_project_number string

Accounting Project Number of the Project

Designated Market Area
designated_market_area string

Designated Market Area of the Project

Returns

The outputs of this operation are dynamic.

Projects - Update Project

Update an existing Project's information.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Name
name True string

Name of the Project

Active
active boolean

Active status of the Project

Address
address string

Street Address of the Project location

City
city string

City in which the Project is located

Country Code
country_code string

Two character Code that represents the Country in which the Project is located (ISO-3166 Alpha-2 format)

Description
description string

Description of the Project

Start Date
start_date string

Date that the contract for the project is signed.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Completion Date
completion_date string

Date that all parties agree the project meets.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Total Value
total_value string

Total amount of construction work performed, planned, or put in place during the project

Warranty Start Date
warranty_start_date string

Warranty Start Date of the Project.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Warranty End Date
warranty_end_date string

Warranty End Date of the Project.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Flag Color
flag string

Flag of the Project

Image ID
image_id integer

ID of the Image of the Project

Office ID
office_id integer

ID of the Office of the Project

Phone
phone string

Phone number of the Project

Project Number
project_number string

Number of the Project

Public Notes
public_notes string

Public Notes of the Project

Square Feet
square_feet integer

Square Footage of the Project

State Code
state_code string

Code that represents the State of the Project (ISO-3166 Alpha-2 format)

Time Zone
time_zone string

Timezone of the Project

Zip
zip string

Zip code of the Project

Parent Job ID
parent_job_id integer

Parent Job ID of the Project

Program ID
program_id integer

Program ID of the Project

Bid Type ID
project_bid_type_id integer

Project Bid Type ID of the Project

Stage ID
project_stage_id integer

Project Stage ID of the Project

Type ID
project_type_id integer

Project Type ID of the Project

Owner Type ID
project_owner_type_id integer

Project Owner Type ID of the Project

Region ID of the Project
project_region_id integer

Project Region ID of the Project

Project Template ID
project_template_id integer

ID of the Project Template as designated by another Project on this company

Origin ID
origin_id string

Third-party ID of the Project

Origin Data
origin_data string

Third-party Data of the Project

Origin Code
origin_code string

Third-party Code of the Project

department_ids
department_ids array of integer

department_ids

Estimated Value
estimated_value string

Estimated Value of the project

Estimated Start Date
estimated_start_date string

Estimated Start Date of the Project

Estimated Completion Date
estimated_completion_date string

Estimated Completion Date of the Project

Returns

The outputs of this operation are dynamic.

Replies - Delete An RFI Response

Deletes a specified response associated with a specified RFI and specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
rfi_id True integer

RFI ID

Reply ID
id True integer

Reply ID

Returns

response
object

Replies - Get Replies

Get list of replies for a specified RFI

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
rfi_id True integer

RFI ID

Returns

The outputs of this operation are dynamic.

Replies - Show RFI Reply

Get detailed information on a specified RFI reply

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
rfi_id True integer

RFI ID

Reply ID
id True integer

Reply ID

Returns

The outputs of this operation are dynamic.

Replies - Update RFI Reply

Updates a specified RFI reply

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
rfi_id True integer

RFI ID

Reply ID
id True integer

Reply ID

Is Official
official True boolean

Official Status

Returns

The outputs of this operation are dynamic.

Resources - Delete Resource

Delete the specified Resource. Note that when a resource is deleted, any assignments to tasks will also be removed.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Resource ID
id True integer

ID of the resource

Returns

response
object

Resources - Get Resources

Get list of all resources in a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Resources - Show Resource

Show detail on the specified Resource.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Resource ID
id True integer

ID of the resource

Returns

The outputs of this operation are dynamic.

Resources - Update Resource

Update the specified Resource.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Resource ID
id True integer

ID of the resource

Name
name string

Name of the Resource

Source ID#
source_uid string

Unique identifier for this resource from the external system which owns the schedule data

Returns

The outputs of this operation are dynamic.

RFI - List Of Possible Assignees

Get all potential Assignees for an RFI

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Returns

The outputs of this operation are dynamic.

RFIs - Get RFIs

Get all RFIs in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

RFI ID
filters[id] string

Return item(s) with the specified IDs

RFI Status
filters[status] string

Return item(s) with the specified RFI Status

Assigned ID
filters[assigned_id] string

RFI Assigned To ID

Created Date
filters[created_at] string

Filter based on created date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Responsible Contractor ID
filters[responsible_contractor_id] string

Return item(s) with the specified Responsible Contractor ID

Cost Code ID
filters[cost_code_id] string

Return item(s) with the specified Cost Code ID or within a range of Cost Code IDs

Received From Login Information ID
filters[received_from_login_information_id] string

Return item(s) with the specified Received From Login Information ID

Location ID
filters[location_id] string

Filters by specific

Updated Date
filters[updated_at] string

Filter based on last updated date format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

RFI Manager ID
filters[rfi_manager_id] string

Return item(s) with the specified RFI Manager ID

Sort Attributes
sort[attribute] string

Attribute by which to sort the list of RFIs

Sort Direction
sort[direction] string

If passed a sort attribute, determines which direction to sort

Returns

The outputs of this operation are dynamic.

RFIs - List Recycled RFIs

Get all deleted RFIs in a specified Project

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

RFIs - Recycle RFI

Send a specified RFI to the Recycle Bin.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
id True integer

RFI ID

Returns

The outputs of this operation are dynamic.

RFIs - Retrieve Recycled RFI

Get a specified RFI from the Recycle Bin.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
id True integer

RFI ID

Returns

The outputs of this operation are dynamic.

RFIs - Show RFI

Get detailed information about a specified RFI in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
id True integer

RFI ID

Returns

The outputs of this operation are dynamic.

RFIs - Update RFI

Updates a specified RFI in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

RFI ID
id True integer

RFI ID

Run Configurable Validations
run_configurable_validations boolean

Whether or not Configurable validations from the corresponding Configurable Field Set should be run

Subject
subject string

Subject of the RFI

Reference
reference string

Reference of the RFI

Accepted
accepted boolean

Accepted Status - closes or opens an RFI

Assignee ID
assignee_id integer

The ID of the Assignee User. *Only admin users can set this field DEPRECATED. Please use assignee_ids instead

assignee_ids
assignee_ids array of integer

Array of IDs of the Assignees of the RFI *Only admin users can set this field **If this param is not provided, the assigned_id will be used instead

Draft status
draft boolean

Draft status (Can only be changed on draft RFIs)

Due Date
due_date string

Due Date *Only admin users can set this field. Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Received From
received_from_login_information_id integer

ID of the Received From User of the RFI

Responsible Contractor
responsible_contractor_id integer

Responsible Contractor Vendor ID

distribution_ids
distribution_ids array of integer

IDs of the Distributions of the RFI

The Number
number string

Number of the RFI *This field will be auto-populated if the RFI is not draft

Is Private
private boolean

Is Private

Schedule Impact Status
status string

Status of the Schedule Impact

Cost Impact
value integer

Value in days of the Schedule Impact

Cost Impact Status
status string

Status of the Cost Impact

Schedule Impact
value float

Cost impact value in dollars

The ID of the Location
location_id integer

ID of the Location

Drawing Number
drawing_number string

Drawing Number of the RFI

Specification ID
specification_section_id integer

ID of the Specification Section of the RFI

ID of the Cost Code
cost_code_id integer

ID of the Cost Code of the RFI

RFI Manager
rfi_manager_id integer

ID of the RFI Manager User of the RFI *Only admin users (or standard users, if the project's configuration allows for it) can set this field

Question
body True string

Body of the Question

File Name
filename string

The Name of the File to be created with extension

File Content
documentContent byte

File Content

Content Type
contentType string

Content Type - Optional

The Custom Textfield 1
custom_textfield_1 string

Custom Textfield 1 of the RFI

The Custom Textfield 2
custom_textfield_2 string

Custom Textfield 2 of the RFI

Returns

The outputs of this operation are dynamic.

Schedule - Get Requested Changes

Get all Requested Changes of a Task.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Task ID
task_id True integer

Task for which all requested changes will be retrieved

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Send User Invite

Send User Invite

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

User ID
id True integer

User ID

Sync Company Users

Sync Company Users

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

ID
id True integer

ID of the Company User

First Name
first_name True string

First Name of the Company User

Last Name
last_name True string

Last Name of the Company User

Job Title
job_title True string

Job Title of the Company User

Address
address True string

Address of the Company User

City
city True string

City of the Company User

Zip
zip True string

Zip code of the Company User

Business Phone
business_phone True string

Business Phone of the Company User

Business Phone Extension
business_phone_extension True string

Business Phone Extension of the Company User

Mobile Phone
mobile_phone True string

Mobile Phone of the Company User

Fax Number
fax_number True string

Fax Number of the Company User

Email Address
email_address True string

Email Address of the Company User

Email Signature
email_signature True string

Email Signature of the Company User

Is Active
is_active True boolean

Active status of the Company User

Is Employee
is_employee True boolean

Employee status of the Company User

Employee ID
employee_id True string

ID of the Employee of the Company User when user[is_employee] is set to true

Notes
notes True string

Notes (notes, keywords, tags) of the Company User

Country Code
country_code True string

Country Code of the Company User (ISO-3166 Alpha-2 format)

State Code
state_code True string

State Code of the Company User (ISO-3166 Alpha-2 format)

Initials
initials True string

Initials of the Company User

Origin ID
origin_id True string

Origin ID of the Company User

Origin Data
origin_data True string

Origin Data of the Company User

Vendor ID
vendor_id True integer

ID of the Vendor of the Company User

Work Classification ID
work_classification_id True integer

ID of the Work Classification for the Company User

Default Permission Template ID
default_permission_template_id True integer

ID of the default Permission Template for the Company User

Company Permission Template ID
company_permission_template_id True integer

ID of the Company Permission Template for the Company User

Returns

The outputs of this operation are dynamic.

Task Items - Get Tasks Items

Get Tasks Items

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

List of IDs
filters[id] string

List of IDs to return values for

Returns

The outputs of this operation are dynamic.

Tasks - Delete Task

Delete the specified Task.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Task ID
id True integer

ID of the task

Returns

response
object

Tasks - List Tasks

List existing tasks for the specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Returns

The outputs of this operation are dynamic.

Tasks - Sync Tasks

This endpoint creates or updates a batch of tasks.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Name
name string

Task name

Start Date
start string

Task start timestamp

Finish Date
finish string

Task finish timestamp

Actual Start
actual_start string

Actual start timestamp for this task

Actual finish
actual_finish string

Actual finish timestamp for this task

Percentage
percentage integer

Percent complete value for this task

Critical Path
critical_path boolean

True if this task is on the critical path

Milestone
milestone boolean

True if this task is a milestone

Row Number
row_number integer

Task Sequence Number

Has Children
has_children boolean

Flag set to true if this is a summary task

Source UID
source_uid string

Unique identifier for this task from the external system.

Parent ID
parent_id integer

ID of the parent task

Full Outline Path
full_outline_path string

Task full outline path

Activity ID
activity_id string

For tasks imported from external systems

wbs
wbs string

Work Breakdown Structure (WBS) number for this task

Schedule Duration
schedule_duration integer

Duration of this task in days as defined by the external system which owns the schedule data

Resource IDs
resource_ids array of integer

Resources assigned to this task, represented as an array of resource ID values

Notes
notes string

Arbitrary notes about this task

Baseline Start
baseline_start string

Baseline start timestamp for this task

Baseline Finish
baseline_finish string

Baseline finish timestamp for this task

Start Variance
start_variance float

Start variance in days for this task

Finish Variance
finish_variance float

Finish variance in days for this task

Returns

The outputs of this operation are dynamic.

Timecard Entries - Delete Timecard Entry

Delete a specified Timecard Entry.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Timecard Entry ID
id True integer

ID of the timecard entry

Returns

response
object

Timecard Entries - Get Timecard Entries

Get all Time Card Entries

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Log Date
log_date date

Entries at specified date. (YYYY-MM-DD)

Start Date
start_date date

Beginning of the date range for entries. (YYYY-MM-DD)

End Date
end_date date

End of the date range for entries. (YYYY-MM-DD)

Page No
page integer

Page number for which you want to retrieve the data

Limit Records
per_page integer

Limit to Number of Records in the response

Created By ID
filters[created_by_id] integer

Return item(s) created by the user with the specified User ID

Returns

The outputs of this operation are dynamic.

ToDos - Delete Todo

Delete a specific ToDo Item in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Todo ID
id True integer

ID of the todo

ToDos - Show Todo

Return detailed information about a ToDo Item in a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

ToDo ID
id True integer

ID of the todo

Returns

The outputs of this operation are dynamic.

ToDos - Update Todo

Update a ToDo item for a specified Project.

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

ToDo ID
id True integer

ID of the todo

Project ID
project_id True integer

ID of the Project the ToDo belongs to

Assignment ID
assignment_id integer

ID of the Assignment of the ToDo

Color
color string

Color of the ToDo

Finish Datetime
finish_datetime string

Finish date-time of the ToDo.Format should be YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30.45+01:00)

Name
name string

Name of the ToDo

Description
description string

Description of the ToDo

Percentage
percentage integer

Percentage of the ToDo

Is Private
private boolean

Private status of the ToDo

Start Date Time
start_datetime string

Start date-time of the ToDo

Returns

The outputs of this operation are dynamic.

Update Company User

Update Company User

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

User ID
id True integer

User ID

First Name
first_name string

First Name of the Company User

Last Name
last_name True string

Last Name of the Company User

Job Title
job_title string

Job Title of the Company User

Address
address string

Address of the Company User

City
city string

City of the Company User

Zip
zip string

Zip code of the Company User

Business Phone
business_phone string

Business Phone of the Company User

Business Phone Ext
business_phone_extension integer

Business Phone Extension of the Company User

Mobile Phone Ext
mobile_phone string

Mobile Phone of the Company User

Fax Number
fax_number string

Fax Number of the Company User

Email Address
email_address True string

Email Address of the Company User. Update requests including this parameter will be rejected unless the requesting user has Directory Admin permissions

Email Signature
email_signature string

Email Signature of the Company User

Is Active
is_active boolean

Active status of the Company User

Is Employee
is_employee boolean

Employee status of the Company User

Employee Id
employee_id string

ID of the Employee of the Company User when Is Employee is set to true

Notes
notes string

Notes (notes, keywords, tags) of the Company User

Country Code
country_code string

Country Code of the Company User (ISO-3166 Alpha-2 format)

State Code
state_code string

State Code of the Company User (ISO-3166 Alpha-2 format)

Initials
initials string

Initials of the Company User

Origin Id
origin_id string

Origin ID of the Company User

Origin Data
origin_data string

Origin Data of the Company User

Vendor Id
vendor_id integer

ID of the Vendor of the Company User

Default Permission Template Id
default_permission_template_id integer

ID of the default Permission Template for the Company User. Requests including this parameter will be rejected unless the requesting user has Directory Admin permissions

Company Permission Template Id
company_permission_template_id integer

ID of the Company Permission Template for the Company User. Requests including this parameter will be rejected unless the requesting user has Directory Admin permissions

Work Classification Id
work_classification_id integer

ID of the Work Classification for the Company User

Avatar
avatar string

Avatar of the Company User

Returns

The outputs of this operation are dynamic.

Update Department

Update Department

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Department ID
id True integer

Department ID

Department name
name string

Department name

Origin Data
origin_data string

Origin Data

Origin Id
origin_id string

Origin Id

Returns

The outputs of this operation are dynamic.

Update Project File

Update Project File

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

File ID
file_id True integer

Project File Id

File Name
filename True string

The Name of the File to be created with extension

Track this file?
is_tracked boolean
Is Private?
explicit_permissions boolean
Description
description string
File Content
documentContent True byte

File Content

Returns

The outputs of this operation are dynamic.

Update Project Folder

Update Project Folder

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Folder ID
folderId True string

Specify the folder in Procore Project

Folder ID
parent_id integer

ID of the parent folder to move the folder to

Folder Name
name string

The Name of the folder to be updated

Is Tracked
is_tracked boolean

Status if a folder should be tracked

Is Explicit
explicit_permissions boolean

Set folder to private

Custom Field
custom_field_%{custom_field_definition_id} string

Value of the custom field

Returns

The outputs of this operation are dynamic.

Update Project Owner Type

Update Project Owner Type

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Owner Type ID
id True integer

Project Owner Type ID

Name
name string

Name of the Project Owner Type

Returns

The outputs of this operation are dynamic.

Update Project Region

Update Project Region

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Region ID
id True integer

Project Region ID

Name
name string

Name of the Project Region

Returns

The outputs of this operation are dynamic.

Update Project Stage

Update Project Stage

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project Stage ID
id True integer

Project Stage ID

Is Bidding Stage
is_bidding_stage boolean

Bidding Stage status of the Project Stage

Name
name string

Name of the Project Stage

Category
category string

Category Type of the Project Stage

Returns

The outputs of this operation are dynamic.

Update Project Type

Update Project Type

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Type ID
id True integer

Project Type ID

Name
name string

Name of the Project Type

Returns

The outputs of this operation are dynamic.

Update Project User

Update Project User

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

User ID
id True integer

User ID

Address
address string

Street Address of the Project User

Avatar
avatar string

Project User Avatar

Business Phone
business_phone string

Business Phone number of the Project User

Business Phone Extension
business_phone_extension integer

Business Phone Extension of the Project User

City
city string

City in which the Project User resides

Country Code
country_code string

Country Code of the Project User (ISO-3166 Alpha-2 format)

Email Address
email_address True string

Email Address of the Project User

Email Signature
email_signature string

Email Signature of the Project User

Employee ID
employee_id string

Employee ID of the Project User

Fax Number
fax_number string

Fax Number of the Project User

First Name
first_name string

First Name of the Project User

Initials
initials string

Initials of the Project User

Is Active
is_active boolean

Active status of the Project User

Is Employee
is_employee boolean

Employee status of the Project User

Job Title
job_title string

Job Title of the Project User

Last Name
last_name True string

Last Name of the Project User

Mobile Phone
mobile_phone string

Mobile Phone number of the Project User

Notes
notes string

Notes (notes/keywords/tags) of the Project User

State Code
state_code string

State Code of the Project User (ISO-3166 Alpha-2 format)

Vendor ID
vendor_id integer

Vendor ID of the Project User

Zip
zip string

Zip Code of the Project User

Returns

The outputs of this operation are dynamic.

Triggers

Procore Webhook Trigger for any Company wide Events

Event Trigger - Triggers a callback notification based on the configured event

Procore Webhook Trigger for any Events

Event Trigger - Triggers a callback notification based on the configured event

Procore Webhook Trigger for any Company wide Events

Event Trigger - Triggers a callback notification based on the configured event

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Webhook Events to Listen - Enter each line or comma separated
resources True string

Webhook Events to Listen - Enter each line or comma separated

Event Type
event_type True string

Event Type

Webhook Unique Name
namespace True string

Webhook Unique Name

Returns

Name Path Type Description
API Version
api_version string

API Version

Company ID
company_id integer

Company ID

Event Type
event_type string

Event type can be create,update or delete

Event ID
id integer

Event ID to track this event later

source_application_id
metadata.source_application_id
Source Company ID
metadata.source_company_id integer

Source Company ID

source_operation_id
metadata.source_operation_id
Source User ID
metadata.source_user_id integer

Source User ID

Resource ID
resource_id integer

Id of the Resource which triggered this event. Coordination Issues,Drawing Areas,Drawing Sets,Drawing Uploads,Drawings,Markup Layers,Pdf Download Pages,Meeting Attendees,Meeting Categories,Meeting Topics,Meetings,Image Categories,Images,Tasks,ToDos,RFI Replies,RFIs,Specification Section Divisions,Specification Section Revisions,Specification Sections,Specification Sets,Submittals,Timecard Entries

Resource Name
resource_name string

Name of the Resource which triggered this event. Coordination Issues,Drawing Areas,Drawing Sets,Drawing Uploads,Drawings,Markup Layers,Pdf Download Pages,Meeting Attendees,Meeting Categories,Meeting Topics,Meetings,Image Categories,Images,Tasks,ToDos,RFI Replies,RFIs,Specification Section Divisions,Specification Section Revisions,Specification Sections,Specification Sets,Submittals,Timecard Entries

Timestamp
timestamp string

Timestamp

ULID
ulid string

ULID

User ID
user_id integer

ID of the user who initiated this event

Procore Webhook Trigger for any Events

Event Trigger - Triggers a callback notification based on the configured event

Parameters

Name Key Required Type Description
Company ID
company_id True integer

Company ID

Project ID
project_id True integer

Project ID

Webhook Events
resources True string

Webhook Events to Listen - Enter each line or comma separated

Event Type
event_type True string

Event Type to listen

Webhook Unique Name
namespace True string

Unique Name for webhook (use alphabets. No special characters or spaces allowed)

Returns

Name Path Type Description
API Version
api_version string

API Version

Company ID
company_id integer

Company ID

Event Type
event_type string

Event type can be create,update or delete

Event ID
id integer

Event ID to track this event later

source_application_id
metadata.source_application_id
Source Company ID
metadata.source_company_id integer

Source Company ID

source_operation_id
metadata.source_operation_id
Source Project ID
metadata.source_project_id integer

Source Project ID

Source User ID
metadata.source_user_id integer

Source User ID

Project ID
project_id integer

Project ID

Resource ID
resource_id integer

Id of the Resource which triggered this event. Coordination Issues,Drawing Areas,Drawing Sets,Drawing Uploads,Drawings,Markup Layers,Pdf Download Pages,Meeting Attendees,Meeting Categories,Meeting Topics,Meetings,Image Categories,Images,Tasks,ToDos,RFI Replies,RFIs,Specification Section Divisions,Specification Section Revisions,Specification Sections,Specification Sets,Submittals,Timecard Entries

Resource Name
resource_name string

Name of the Resource which triggered this event. Coordination Issues,Drawing Areas,Drawing Sets,Drawing Uploads,Drawings,Markup Layers,Pdf Download Pages,Meeting Attendees,Meeting Categories,Meeting Topics,Meetings,Image Categories,Images,Tasks,ToDos,RFI Replies,RFIs,Specification Section Divisions,Specification Section Revisions,Specification Sections,Specification Sets,Submittals,Timecard Entries

Timestamp
timestamp string

Timestamp

ULID
ulid string

ULID

User ID
user_id integer

ID of the user who initiated this event

Definitions

object

This is the type 'object'.