GET /rest/v1.0/images

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.

Servers

https://api.procore.com

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
`image_category_id`	Integer	No	Optional. ID of the image category to filter the images by.
`project_id`	Integer	Yes	Unique identifier for the project.
`filterscreated_at`	String	No	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-DDTHH:MM:SS+XX:00...`YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset
`sort`	String	No	Field to sort by. If the field is passed with a - (EX: -created_at) it is sorted in reverse order Possible values: `"deleted_at"` `"taken_at"` `"exposure_date"` `"most_recent"` `"created_at"`
`filterstrade_ids[]`	Array	No	Array of Trade IDs. Returns item(s) with the specified Trade IDs.
`filterslocation_id[]`	Array	No	Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.
`filterslog_date`	String	No	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".
`filtersstarred`	Boolean	No	If true, returns only item(s) with a `starred` status. Default value: false
`page`	Integer	No	Page
`per_page`	Integer	No	Elements per page
`filtersprivate`	Boolean	No	If true, returns only item(s) with a `private` status. Default value: false
`filtersupdated_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
`filtersinclude_sublocations`	Boolean	No	Use together with `filters[location_id]` Default value: false
`filtersid[]`	Array	No	Return item(s) with the specified IDs.
`serializer_view`	String	No	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, 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. Possible values: `"android"` `"normal"` `"mobile"` `"mobile_feed"` `"ids_only"` `"prostore_file"`
`filtersquery`	String	No	Return item(s) containing search query

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.