Get user links ⛓

This returns all linked accounts associated with a user. It returns the user's account details along with the business the account resides on.

What are links?

A link is a connection between your user's account on your platform to another user's account on another platform on Thepeer. With links, your users can perform a direct charge via our SDKs or available libraries.


URL ParameterDescription
{{USER_REFERENCE}}the reference returned when the user was indexed

Sample response

"links": [
"id": "jump-out-the-house",
"user": {
"name": "Playboi Carti",
"identifier": "playboi",
"identifier_type": "username",
"email": "",
"reference": "king-vamp-king-vamp",
"created_at": "2021-04-17T16:28:18.000000Z",
"updated_at": "2021-05-04T08:37:22.000000Z"
"peer": {
"user": {
"name": "Kanye West",
"identifier": "",
"identifier_type": "email",
"email": "",
"reference": "donda-donda-donda-donda",
"created_at": "2021-04-16T05:19:33.000000Z",
"updated_at": "2021-04-16T05:36:07.000000Z"
"business": {
"id": "pure-soul-to-the-moon",
"name": "Cash App",
"logo": "",
"logo_colour": "#28c101",
"identifier_type": "email"
"created_at": "2021-06-21T11:55:54.000000Z",
"updated_at": "2021-06-21T11:55:54.000000Z"
idThe link's identifier
userThe user object of the user the account is being linked to
peerThe receipt peer object contains objects of the user and the business your user is linked to

Be a yardstick of quality. Some people aren't used to an environment where excellence is expected.

— Steve Jobs


Don't attempt fetching links for users not on your business, it won't work, just thought to let you know.