GET /rest/v1.0/projects/{project_id}/locations
Return a list of Locations associated with a Project.
Servers
- https://api.procore.com
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 |
|---|---|---|---|
page |
Integer | No |
Page |
filters[parent_id] |
Integer | No |
Return location(s) with the specified parent_ids. |
filters[sublocations_for] |
Integer | No |
Return sublocations (descendants) of the specified location ids. |
filters[code][] |
Array | No |
Return location(s) matching any of the specified codes in the search term. |
filters[superlocations_for] |
Integer | No |
Return superlocations (ancestors) of the specified location ids. |
filters[id][] |
Array | No |
Return item(s) with the specified IDs. |
filters[search_with_code] |
String | No |
Return item(s) where the location code or the location name match the search term |
sort |
String | No |
Possible values:
|
per_page |
Integer | No |
Elements per page |
filters[search] |
String | No |
Returns item(s) matching the specified search query string. |
filters[depth_range] |
String | No |
Return item(s) with a tree depth within the specified range. Examples:
|
filters[updated_at] |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
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.