> ## Documentation Index
> Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Locations

> Retrieves a list of locations

**Security**

The requesting user must have the following permission to retrieve locations:

- Administration → Locations → View Locations

_Location access:_ location access is separate from permissions — the endpoint returns data only for locations assigned to the requesting API user. A user with the correct permission but no assigned locations receives no records.

## OpenAPI

````json GET /public/v1/core/locations
{
  "openapi": "3.0.1",
  "info": {
    "title": "R365 Public API",
    "contact": {
      "name": "R365 Services Team",
      "email": "r365@restaurant365.com"
    },
    "version": "1.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/public/v1/core/locations": {
      "get": {
        "tags": [
          "core"
        ],
        "summary": "Locations",
        "description": "Retrieves a list of locations\n\n**Security**\n\nThe requesting user must have the following permission to retrieve locations:\n\n- Administration → Locations → View Locations\n\n_Location access:_ location access is separate from permissions — the endpoint returns data only for locations assigned to the requesting API user. A user with the correct permission but no assigned locations receives no records.",
        "parameters": [
          {
            "$ref": "#/components/parameters/TenantId"
          },
          {
            "name": "modifiedOnStart",
            "in": "query",
            "description": "Starting datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the upper bound.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "modifiedOnEnd",
            "in": "query",
            "description": "Ending datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the lower bound.",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "locationNumbers",
            "in": "query",
            "description": "Filter by location number. Accepts a comma-separated list, e.g. 314,3030.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 250,
              "default": 250
            },
            "description": "Maximum number of top-level objects to return in one page."
          },
          {
            "name": "continuationToken",
            "in": "query",
            "description": "Continuation token for pagination. Use the nextLink value from a previous response to fetch the next page.",
            "schema": {
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "list of location entities",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicLocationsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range."
          },
          "401": {
            "description": "Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant."
          },
          "403": {
            "description": "Forbidden — the caller lacks the permission required for this operation."
          },
          "404": {
            "description": "Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired."
          },
          "409": {
            "description": "Conflict — the request conflicts with the current state of the resource and cannot be applied."
          },
          "422": {
            "description": "Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid."
          },
          "429": {
            "description": "Too Many Requests — the caller has exceeded the rate limit; retry after a short delay."
          },
          "500": {
            "description": "Internal Server Error — an unexpected error occurred while processing the request."
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "TenantId": {
        "name": "x-r365-context-tenant-id",
        "in": "header",
        "required": true,
        "description": "Identifies the R365 tenant the request applies to. Required on every request.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "PublicLocationsResponse": {
        "type": "object",
        "description": "Paginated response containing locations.",
        "properties": {
          "items": {
            "type": "array",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/Location"
            },
            "description": "Locations for the current page."
          },
          "nextLink": {
            "type": "string",
            "nullable": true,
            "description": "URL of the next page, or null on the last page."
          }
        }
      },
      "Location": {
        "type": "object",
        "description": "A location.",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier of the location."
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "Display name of the location."
          },
          "number": {
            "type": "string",
            "nullable": true,
            "description": "Location number."
          },
          "timeZone": {
            "type": "string",
            "nullable": true,
            "description": "Windows time-zone identifier for the location, e.g. \"Pacific Standard Time\"."
          },
          "addresses": {
            "type": "array",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/LocationAddress"
            },
            "description": "Addresses for the location."
          }
        }
      },
      "LocationAddress": {
        "type": "object",
        "description": "A location address.",
        "properties": {
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "addressLine3": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "stateOrProvince": {
            "type": "string",
            "nullable": true,
            "description": "State or province code."
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          }
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "Bearer"
      }
    }
  }
}
````