List Images
list_imagesRead-onlyIdempotent
Retrieve a paginated list of images from a Procore project's photo album, with filters for category, dates, location, and more.
Instructions
Return a list of all Images from a Project's Photo Album (Image Category). See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Use this to enumerate Photos when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Photos. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Project Management > Photos. Endpoint: GET /rest/v1.0/images
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Query string parameter — unique identifier for the project. | |
| image_category_id | No | Query string parameter — optional. ID of the image category to filter the images by. | |
| 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__daily_log_segment_id | No | Query string parameter — daily Log Segment ID filter | |
| filters__log_date | No | Query string parameter — date of Photos added to the Daily Log in the format "YYYY-MM-DD", or a range of dates in the format "YYYY-MM-DD...YYYY-MM-DD". | |
| filters__private | No | Query string parameter — if true, returns only item(s) with a `private` status. | |
| filters__starred | No | Query string parameter — if true, returns only item(s) with a `starred` status. | |
| filters__location_id | No | Query string parameter — location ID. Returns item(s) with the specified Location ID or a range of Location IDs. | |
| filters__include_sublocations | No | Query string parameter — use together with `filters[location_id]` | |
| filters__trade_ids | No | Query string parameter — array of Trade IDs. Returns item(s) with the specified Trade IDs. | |
| filters__projection | No | Query string parameter — return items with the specified projection type. | |
| filters__query | No | Query string parameter — return item(s) containing search query | |
| 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__updated_at | No | Query string parameter — 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 `YYY... | |
| filters__uploader_id | No | Query string parameter — return item(s) uploaded by the specified User IDs | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| sort | No | Query string parameter — field to sort by. If the field is passed with a - (EX: -created_at) it is sorted in reverse order | |
| serializer_view | No | Query string parameter — the 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, comment... |