GET /rest/v1.0/projects/{project_id}/checklist/schedules

Returns the Checklist Schedules from Checklists (Inspections) on the Project

Servers

Path parameters

Name Type Required Description
project_id Integer Yes

Unique identifier for the project.

Request headers

Name Type Required Description
Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
filters[first_inspection_due_at][] Array No

Return schedule(s) with the specified First Inspection Due Date

sort String No

Sort schedule(s) by the chosen param; check below for a list of options. The direction of sorting is ascending by default; for descending sort, insert the - symbol before the param.

Possible values:

  • "inspection_type_name"
  • "frequency"
  • "name"
  • "inspection_template_name"
  • "inspection_type_then_name"
  • "inspections_created"
  • "ends_at"
  • "location_id"
  • "first_inspection_due_at"
  • "location_name"
filters[frequency][] Array No

Return schedule(s) with the specified Frequency Types

filters[assignee_id][] Array No

Return schedule(s) with the specified Assignee IDs

filters[inspection_type_id][] Array No

Return schedule(s) with the specified Checklist Type IDs

filters[location_id][] Array No

Return schedule(s) with the specified Location IDs

filters[list_template_id][] Array No

Return schedule(s) with the specified Inspection Template IDs

filters[ends_at][] Array No

Return schedule(s) with the specified Last Inspection Due Date.

filters[ended] Boolean No

Return schedule(s) that are finished when true, returns unfinished schedule(s) otherwise

page Integer No

Page

per_page Integer No

Elements per page

filters[updated_at] String No

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

filters[equipment_id][] Array No

Return schedule(s) with the specified Equipment IDs

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.