List Witness Statements
list_witness_statementsRead-onlyIdempotent
Retrieve paginated witness statements for a project. Filter by incident, date, witness, or search query to find specific records.
Instructions
Returns a list of Witness Statements for a given project. Use this to enumerate Incidents when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Incidents. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Project Management > Incidents. Endpoint: GET /rest/v1.0/projects/{project_id}/incidents/witness_statements
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| incident_id | No | Query string parameter — incident ID. When provided, the list will be scoped to only the Witness Statements for a given Incident. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__created_at | No | Query string parameter — return item(s) created 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-... | |
| filters__date_received | No | Query string parameter — return item(s) within the specified date received date range. This assumes the dates provided are in the project time zone. | |
| filters__witness_id | No | Query string parameter — return item(s) with the specified Witness (Party) ID. | |
| filters__query | No | Query string parameter — return item(s) containing query | |
| sort | No | Query string parameter — sort order for results. Prefix with '-' for descending order |