Location

Request and retrieve real-time location data via iMessage.

Use these endpoints to request a contact’s location, retrieve location data for contacts who are sharing with you, and subscribe to webhooks when someone starts or stops sharing their location.

Coordinates are returned in GeoJSON format: [longitude, latitude] or [longitude, latitude, altitude] if altitude is available.

Request location sharing

POST/v3/chats/{chatId}/location/request

Get location data

GET/v3/chats/{chatId}/location

ModelsExpand 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

LocationRequestResponse object { message, success }

message: string

success: boolean