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

# Get shared locations

> Read the current location of everyone sharing with your agent in this chat. `data` is a GeoJSON FeatureCollection (RFC 7946) with one Feature per person sharing; `coordinates` are `[longitude, latitude]`. `features` is empty when nobody is sharing: never shared, stopped, or past the share's end. There is no webhook per position update; poll this route and use `properties.updated_at` to judge freshness. The response is not cached.



## OpenAPI

````yaml /api-reference/openapi.mint.yaml get /v1/chats/{chatId}/location
openapi: 3.1.0
info:
  title: Relay API
  version: 1.0.0
  description: >-
    Create conversations between users and agents.


    Send multipart Messages, manage Chats, upload Attachments, and receive agent
    events.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.staging.relayapp.im
    description: Relay API
security:
  - BearerAuth: []
tags:
  - name: Agents
    x-page-title: Agents
    description: >-
      Read who owns the authenticated agent, manage who is always and never
      allowed to message it, manage its OAuth2 client for Log in with Relay, and
      delete existing developer-managed agents.
  - name: Chats
    x-page-title: Chats
    description: Create, retrieve, and update direct or group chats.
  - name: Messages
    x-page-title: Messages
    description: Send and retrieve messages, replies, reactions, and receipts.
  - name: Attachments
    x-page-title: Attachments
    description: Allocate, upload, retrieve, and delete attachment bytes.
  - name: Blocked Handles
    x-page-title: Blocked Handles
    description: |-
      Block or unblock registered Relay Handles. In a direct Chat, a block in
      either direction means a Message is stored for the sender and never
      delivered to the other party, silently. In a group Chat, blocking is one
      way: you do not receive Messages from a Handle you blocked, but that
      Handle still receives yours, and every other member receives as normal.
      Blocking does not delete existing Chats or history.
  - name: Contact Card
    x-page-title: Contact Card
    description: Manage the authenticated agent's Relay contact card.
  - name: Webhooks
    x-page-title: Webhooks
    description: Register signed webhook destinations.
  - name: WebSocket
    description: Receive agent events over a durable acknowledged WebSocket.
  - name: Contacts
    description: Request a user Contact.
  - name: Directory
    description: Find public agents by category or task. No credential is needed.
  - name: Payments
    x-page-title: Payments
    description: Ask a person to pay, on your organization's own connected Stripe account.
  - name: Calls
    description: >-
      Start, answer, end and read individual user-agent audio calls. Call events
      use Relay's normal agent event delivery, and both Contacts join the
      authenticated Call room as WebRTC audio participants.
paths:
  /v1/chats/{chatId}/location:
    get:
      tags:
        - Chats
      summary: Get shared locations
      description: >-
        Read the current location of everyone sharing with your agent in this
        chat. `data` is a GeoJSON FeatureCollection (RFC 7946) with one Feature
        per person sharing; `coordinates` are `[longitude, latitude]`.
        `features` is empty when nobody is sharing: never shared, stopped, or
        past the share's end. There is no webhook per position update; poll this
        route and use `properties.updated_at` to judge freshness. The response
        is not cached.
      operationId: getLocation
      parameters:
        - name: chatId
          in: path
          required: true
          description: Chat in which your agent is an active participant.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Current shared locations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChatLocationResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    GetChatLocationResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
            - type
            - features
          properties:
            type:
              type: string
              const: FeatureCollection
            features:
              type: array
              items:
                $ref: '#/components/schemas/LocationFeature'
    LocationFeature:
      type: object
      required:
        - type
        - geometry
        - properties
      properties:
        type:
          type: string
          const: Feature
        geometry:
          type: object
          required:
            - type
            - coordinates
          properties:
            type:
              type: string
              const: Point
            coordinates:
              type: array
              description: '[longitude, latitude]'
              minItems: 2
              maxItems: 2
              items:
                type: number
        properties:
          type: object
          required:
            - handle
            - updated_at
          properties:
            handle:
              type: string
              description: Handle of the person sharing.
            updated_at:
              type: string
              format: date-time
              description: When this position arrived.
    ErrorResponse:
      type: object
      required:
        - error
        - success
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
        success:
          type: boolean
          description: Always false for error responses
        trace_id:
          type: string
          description: Unique trace ID for request tracing and debugging
    ErrorDetail:
      type: object
      required:
        - status
        - code
        - message
        - doc_url
      properties:
        status:
          type: integer
          description: HTTP status code (e.g., 400, 404, 500)
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: Human-readable error message
        doc_url:
          type: string
          description: Link to documentation for this error code
        retry_after:
          type: integer
          description: >-
            Number of seconds to wait before retrying. Only present on 429 rate
            limit errors.
    ErrorCode:
      type: integer
      description: Relay API error code.
  responses:
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden - no access to this resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Bearer token authentication. Include your API token in the Authorization
        header.


        Format: `Authorization: Bearer <your-token>`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.