Skip to main content
GET
/
{instance}
/
lids
Get all known LID mappings
curl --request GET \
  --url https://app.hypersender.com/api/whatsapp/v2/{instance}/lids \
  --header 'Authorization: Bearer <token>'
[
  {
    "lid": "1111111@lid",
    "pn": "[email protected]"
  },
  {
    "lid": "2222222@lid",
    "pn": "[email protected]"
  }
]
Returns the linked-identifier mappings already known by this instance. Use this endpoint when you need to:
  • Build a local cache of known @lid and @c.us pairs.
  • Page through large mapping sets with limit and offset.
  • Check which conversions are already available before resolving individual identifiers.
A mapping appears here only after the instance has already learned it from contact or conversation data.

​
Response Example

[
  {
    "lid": "1111111@lid",
    "pn": "[email protected]"
  },
  {
    "lid": "2222222@lid",
    "pn": "[email protected]"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept
string

application/json

Example:

"application/json"

​
Content-Type
string

application/json

Example:

"application/json"

Path Parameters

​
instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Query Parameters

​
limit
integer
default:100

Maximum number of mappings to return

Required range: x >= 0
Example:

100

​
offset
integer
default:0

Number of mappings to skip before returning results

Required range: x >= 0
Example:

0

Response

Successful response

​
lid
string
required

Linked identifier for the contact

Example:

"1111111@lid"

​
pn
string
required

Phone-number-based chat ID for the same contact

Example:

"[email protected]"