Skip to main content
GET
/
api
/
{session}
/
lids
Get mapping of all known lids to phone number
curl --request GET \
  --url https://{host}/api/{session}/lids \
  --header 'apikey: <api-key>'
{
  "lids": [
    {
      "lid": "12345678901234567890",
      "phone": "5511999999999"
    },
    {
      "lid": "09876543210987654321",
      "phone": "5511888888888"
    }
  ]
}

​
Description

This endpoint returns all known mappings between LIDs (Local IDs) and phone numbers. LID is a local identifier used by WhatsApp to map contacts efficiently.

​
URL Parameters

​
session
string
required
Unique authenticated session ID
{
  "lids": [
    {
      "lid": "12345678901234567890",
      "phone": "5511999999999"
    },
    {
      "lid": "09876543210987654321",
      "phone": "5511888888888"
    }
  ]
}

​
Status Codes

  • 200 - Mappings returned successfully
  • 401 - Unauthorized session
  • 404 - Session not found

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/lids

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Query Parameters

​
limit
number
default:100
​
offset
number
default:0

Response

200 - application/json
​
lid
string

User's linked ID

Example:

"1111111@lid"

​
pn
string

User's phone number (chat id)

Example:

"3333333@c.us"