API Reference

Accounts

Contacts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search contacts

GET/v1/accounts/{accountID}/contacts

Search contacts on a specific account using merged account contacts, network search, and exact identifier lookup.

Path ParametersExpand Collapse

accountID: string

Account ID this resource belongs to.

Query ParametersExpand Collapse

query: string

Text to search users by. Network-specific behavior.

minLength1

ReturnsExpand Collapse

items: array of User { id, cannotMessage, email, 5 more }

id: string

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

cannotMessage: optional boolean

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

email: optional string

Email address if known. Not guaranteed verified.

fullName: optional string

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

imgURL: optional string

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

isSelf: optional boolean

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

phoneNumber: optional string

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

username: optional string

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

Search contacts

HTTP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

curl http://localhost:23373/v1/accounts/$ACCOUNT_ID/contacts \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN"

200 example

{
  "items": [
    {
      "id": "id",
      "cannotMessage": true,
      "email": "email",
      "fullName": "fullName",
      "imgURL": "imgURL",
      "isSelf": true,
      "phoneNumber": "phoneNumber",
      "username": "username"
    }
  ]
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "cannotMessage": true,
      "email": "email",
      "fullName": "fullName",
      "imgURL": "imgURL",
      "isSelf": true,
      "phoneNumber": "phoneNumber",
      "username": "username"
    }
  ]
}