Get a list of Procore objects of the same type, with a set of specified fields for each object.
This action can be used to execute most Procore API calls that use an HTTP GET request and return an array of objects (rather than a single object). Please refer to the Procore API Reference to find such APIs; most of them begin with the word "List". Here are just a handful of Procore APIs that you can invoke with this action:
|Required||The Procore API endpoint that you wish to invoke, without the "vapid" prefix. Please refer to the Procore Actions overview for more on the |
|Optional||A comma-separated list of fields to be retrieved from the Procore object.|
To get a list of all possible field names that you can retrieve, look at the Responses section of the corresponding Procore API documentation — any key from the JSON response can be used. For instance, for the List Accident Logs API, field names include
|Optional||The data type of the field called |
Refer to the Responses section of your Procore API's documentation to determine which fields are of type
|Optional||The time zone in which any |
This input is unnecessary if no
|The URL of the DataSet JSON file containing the objects retrieved by the query. Each row represents a Procore object, and each column represents a field specified by the |
|The name of the DataSet JSON file containing the objects retrieved by the query.|
|The number of records returned (i.e. the number of rows in the returned DataSet file).|
Suppose you are using a Procore Webhook to dispatch a GoFormz form when a new Incident is created in Procore, and you want to pre-fill this form with some information. One of the fields you want to pre-fill is the name of the Safety Manager on the project. Here is how you might go about retrieving the name of the safety manager.
Your workflow would start with the Procore Event trigger, which listens for the Procore Webhook to initiate the workflow. Then you might use this Query action configured as follows:
In this example, we use Procore's List Project Roles API. We construct the
apiPath as described in the API documentation, using the "project_id" field from the Webhook trigger to fill in the required project ID query parameter, and filtering on the role of "Safety Manager". Then we select all the fields available in the Responses section as our return values —
Next in your workflow, you might use the Filter DataSet and Select DataSet Row actions to extract the
contact_id from the
dataSetUrl returned by this Query action. And you may pass the
contact_id to a Lookup Object step, to retrieve the name of the project's Safety Manager from Procore. Then finally you can create a new form with Create Form and pre-fill the Safety Manager's name in the appropriate form fields.
Updated over 4 years ago