Friends

Invite other users of the same GeoPulse instance as friends and choose what each friend can see: live location, timeline, or both. Friend data is only returned when the friend has granted the matching permission.

📄️ Send a friend invitation

Invites another user of this GeoPulse server, identified by email, to become friends.

📄️ List received invitations

Returns pending friend invitations sent to the signed-in user.

📄️ List sent invitations

Returns friend invitations the signed-in user has sent.

📄️ Cancel a friend invitation

Withdraws a pending invitation you sent.

📄️ Accept a friend invitation

Accepts an invitation sent to you, and you and the sender become friends. Choose what you share with the permission endpoints.

📄️ Reject a friend invitation

Declines an invitation sent to you.

📄️ List friends

Returns the friends of the signed-in user, with their last known location when they share their live location, and which permissions each side has granted.

📄️ Find users to invite

Searches users on this server by email or full name, excluding yourself, existing friends, and users with a pending invitation. Returns at most 20 users.

📄️ List what you share with friends

Returns your timeline and live-location sharing settings for every friend.

📄️ Get friends' recent trails

Returns the recent GPS points of every friend who shares their live location with you, for drawing their movement on a map.

📄️ Remove a friend

Ends the friendship for both users. Shared permissions are removed.

📄️ Get a friend's location

Returns the latest GPS point of a friend. Requires the friend to share their live location with you.

📄️ Share your timeline with a friend

Turns sharing of your full timeline with a friend on or off.

📄️ Get what you share with a friend

Returns whether you share your timeline and your live location with a friend.

📄️ Share your live location with a friend

Turns sharing of your current location with a friend on or off.