Get location data

GET/v3/chats/{chatId}/location

Retrieve the current location for contacts sharing with you in a chat.

The response is wrapped in the standard { "success": true, "data": ... } envelope — the body is not a bare GeoJSON document. data is a GeoJSON FeatureCollection with a Feature for each participant actively sharing their location.

Works for both 1:1 and group chats. In group chats, data.features contains a separate feature for each participant who is sharing. Each feature’s properties.handle identifies the user.

Returns an empty data.features array if no one is sharing or no location data is available yet. If sharing started but this stays empty, see the Location Sharing overview.

Poll this endpoint to track a moving contact. properties.updated_at reflects when each participant’s location was last updated. There is no coordinate-update webhook. See the Location Sharing overview for polling guidance.

Path ParametersExpand Collapse

chatId: string

formatuuid

ReturnsExpand Collapse

GetChatLocationResponse object { data, success }

data: object { features, type }

features: array of object { geometry, properties, type }

geometry: object { coordinates, type }

coordinates: array of number

[longitude, latitude] or [longitude, latitude, altitude]

type: "Point"

properties: object { handle, address, locality, updated_at }

handle: string

Phone number or email of the person sharing their location

address: optional string

Full street address

locality: optional string

City or locality name

updated_at: optional string

When the location was last updated

formatdate-time

type: "Feature"

type: "FeatureCollection"

success: boolean

Get location data

curl https://api.linqapp.com/api/partner/v3/chats/$CHAT_ID/location \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY"

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format",
    "doc_url": "https://docs.linqapp.com/error/codes/1xxx/1002/"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format",
    "doc_url": "https://docs.linqapp.com/error/codes/1xxx/1002/"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}