---
title: Search users - Beeper Developer Docs
---

Deprecated

GET/v0/search-users

- Beeper Desktop API server http\://localhost:23373/v0/search-users

Search users across on a specific account using the network’s search API. Only use for creating new chats. **Use [`GET /v1/accounts/{accountID}/contacts`](/desktop-api-reference/resources/contacts/methods/search/index.md) instead.**

## Parameters

### Query Parameters

**accountID**

required

Beeper account ID this resource belongs to.

string

Beeper account ID this resource belongs to.

**query**

required

Text to search users by. Network-specific behavior.

string

\>= 1 characters

Text to search users by. Network-specific behavior.

## Responses

### 200

Tool executed successfully

Select media typeapplication/json

object

**items**

required

Array\<object>

A person on or reachable through Beeper. Values are best-effort and can vary by network.

object

**id**

required

Stable Beeper user ID. Use as the primary key when referencing a person.

string

**username**

Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.

string

**phoneNumber**

User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.

string

**email**

Email address if known. Not guaranteed verified.

string

**fullName**

Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.

string

**imgURL**

Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.

string

**cannotMessage**

True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.

boolean

**isSelf**

True if this user represents the authenticated account’s own identity.

boolean

### 400

Invalid request parameters

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 401

Access token is missing or invalid

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 403

Access token does not have the required scope

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 404

Resource not found

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 422

Unprocessable entity - validation error

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 429

Too many requests - rate limit exceeded

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 500

Internal server error

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string