List Project Locations
list_project_locationsRead-onlyIdempotent
Retrieve a paginated list of project locations. Filter by IDs, parent, code, search, or depth range to find specific locations.
Instructions
Return a list of Locations associated with a Project. Use this to enumerate Project records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Project records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Core > Project. Endpoint: GET /rest/v1.0/projects/{project_id}/locations
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__parent_id | No | Query string parameter — return location(s) with the specified parent_ids. | |
| filters__code | No | Query string parameter — return location(s) matching any of the specified codes in the search term. | |
| filters__search | No | Query string parameter — returns item(s) matching the specified search query string. | |
| filters__search_with_code | No | Query string parameter — return item(s) where the location code or the location name match the search term | |
| filters__superlocations_for | No | Query string parameter — return superlocations (ancestors) of the specified location ids. | |
| filters__sublocations_for | No | Query string parameter — return sublocations (descendants) of the specified location ids. | |
| 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... | |
| sort | No | Query string parameter — sort order for results. Prefix with '-' for descending order | |
| 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__depth_range | No | Query string parameter — return item(s) with a tree depth within the specified range. Examples: `0...1` - Parents and children `0...2` - Parents, children, and grandchildren `1...2` - Children and grandchildren |