> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get All Known LIDs
> List the @lid to @c.us mappings already known by a Hypersender WhatsApp instance.
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
```json theme={null}
[
{
"lid": "1111111@lid",
"pn": "3333333@c.us"
},
{
"lid": "2222222@lid",
"pn": "4444444@c.us"
}
]
```
## OpenAPI
````yaml v2/api-reference/whatsapp/whatsapp-collection.json GET /{instance}/lids
openapi: 3.1.0
info:
version: v2.0
title: Hypersender WhatsApp API Docs
description: >
The Hypersender WhatsApp API is a powerful api to send and recieve messages
using your own whatsapp number.
Without the high costs of Meta's Whatsapp business API.
In this Docs you'll learn how to use and integrate Hypersnder Whatsapp API
into your existing system/service or application using simple API endpoints.
## What's New in V2?
**Queued Responses:** All requests in V2 are now queued for improved
reliability and performance. When you make a request, you'll receive an
immediate response with a `queued_request_uuid` that you can use to check
the status of your request.
**Example Response:**
```json
{
"queued": true,
"message": "Processing your request...",
"queued_request_uuid": "a0816120-7e37-4e8b-8cf3-92deb2cdc133",
"queued_request_link": "https://app.hypersender.com/api/whatsapp/v2/{instance}/queued-requests/{queued_request_uuid}"
}
```
Use the `queued_request_link` or the **Get Queued Request** endpoint to
check the actual message response once it's processed.
**What you can Do?**
- Send Text and basic Url messages.
- Send Media through Link or uploaded file.
- Send Audio through Link or uploaded file.
- Send Contact Card
- Send Location
- Send Poll votes
**You can also**
- React to a message
- Forward messages to other chats
- Acknowledge messages (mark as read)
- Star and unstar messages
**Quick Demo**
**Learn how to use Hypersender whatsapp API to send a message using Postman:**
[Demo Link](https://app.hypersender.com/send-whatsapp-message-in-postman) **to easily interact with our API.**
**postman collection**
You can download our [Postman
Collection](https://docs.hypersender.com/whatsapp-postman-collection.json)
to easily interact with our API.
## Servers (Endpoints)
- Production (activated):
[https://app.hypersender.com/api/whatsapp/v2](https://app.hypersender.com/api/whatsapp/v2)
servers:
- url: https://app.hypersender.com/api/whatsapp/v2
description: Production
security:
- Authorization: []
paths:
/{instance}/lids:
get:
tags:
- Contacts
summary: Get all known LID mappings
description: List the @lid to @c.us mappings already known by the instance.
parameters:
- name: Accept
in: header
description: application/json
schema:
type: string
example: application/json
- name: Content-Type
in: header
description: application/json
schema:
type: string
example: application/json
- name: instance
in: path
description: Instance UUID copied from hypersender dashboard
required: true
schema:
type: string
example: '{{ instance_id }}'
- name: limit
in: query
description: Maximum number of mappings to return
required: false
schema:
type: integer
minimum: 0
default: 100
example: 100
- name: offset
in: query
description: Number of mappings to skip before returning results
required: false
schema:
type: integer
minimum: 0
default: 0
example: 0
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LidMapping'
examples:
Default:
value:
- lid: 1111111@lid
pn: 3333333@c.us
- lid: 2222222@lid
pn: 4444444@c.us
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
security:
- Authorization: []
components:
schemas:
LidMapping:
type: object
properties:
lid:
type: string
description: Linked identifier for the contact
example: 1111111@lid
pn:
type: string
description: Phone-number-based chat ID for the same contact
example: 3333333@c.us
required:
- lid
- pn
NotFoundError:
type: object
title: NotFoundError
example:
message: Resource not found.
properties:
message:
type: string
x-examples:
Example 1:
message: Resource not found.
x-stoplight:
id: ar3vz55asbxme
ValidationError:
type: object
title: ValidationError
properties:
message:
type: string
errors:
type: object
description: Invalid or missing feilds will be shown here
statusCode:
type: number
example:
message: The given data was invalid.
errors: {}
statusCode: 422
required:
- errors
- statusCode
x-examples:
Multiple fields Error:
message: The given data was invalid.
errors:
messages:
- The number you want to send the message to is not on whatsapp.
jid: 20121323124131@s.whatsapp.net
exists: false
statusCode: 422
'Single Field error ':
message: The given data was invalid.
errors:
messages:
- textMessage.text should not be empty
statusCode: 422
x-stoplight:
id: 90x3wfxw7gqcb
ServerError:
type: object
title: ServerError
properties:
message:
type: string
example:
message: Internal Server Error
x-stoplight:
id: 2fhq2gihsfreh
securitySchemes:
Authorization:
type: http
scheme: bearer
````