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

# Get Location

> Workspace-scoped, cursor-paginated list of `location` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).

## Complex Usage Example

### Advanced Location Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, status filtering, and sorting for retrieving locations:

```bash theme={null}
curl -X GET "https://api.well.com/v1/locations?include=persons,companies,workspaces&workspace_id=550e8400-e29b-41d4-a716-446655440000&company_id=550e8400-e29b-41d4-a716-446655440001&is_registered=true&is_primary=true&created_at_from=2023-01-01T00:00:00Z&created_at_to=2023-12-31T23:59:59Z&updated_at_from=2023-06-01T00:00:00Z&sort=-created_at&page[limit]=20&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyMy0xMS0wMlQxMDozMDowMFoiLCJpZCI6ImxvY2F0aW9uOS11dWlkIn0=" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```


## OpenAPI

````yaml GET /v1/locations
openapi: 3.1.0
info:
  title: Well Document API
  version: 1.0.0
  description: API for uploading and managing financial documents in the Well platform
servers:
  - url: https://api.wellapp.ai
security: []
paths:
  /v1/locations:
    get:
      tags:
        - Records read endpoints
      summary: List Locations
      description: >-
        Workspace-scoped, cursor-paginated list of `location` records. Served by
        the generic read-only resource handler over the data-views pipeline
        (Hasura row-level security).
      operationId: listLocations
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 50
            maximum: 200
          description: Page size (max 200).
        - name: cursor
          in: query
          schema:
            type: string
          description: Opaque keyset cursor; omit for the first page.
        - name: orderBy
          in: query
          schema:
            type: string
          description: Field to order by.
        - name: direction
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: workspaceId
          in: query
          schema:
            type: string
            format: uuid
          description: Optional explicit workspace scope (Firebase-authenticated callers).
      responses:
        '200':
          description: A page of location records.
          content:
            application/json:
              example:
                data:
                  - type: location
                    id: uuid
                    attributes: {}
                meta:
                  total: 0
                  count: 0
                links:
                  next: null
        '401':
          description: Unauthenticated.
        '403':
          description: Workspace scope not permitted.

````