> ## Documentation Index
> Fetch the complete documentation index at: https://docs.periskope.app/llms.txt
> Use this file to discover all available pages before exploring further.

# The Phone Object

> A phone — a slot in the workspace that a WhatsApp account connects to by scanning a QR code. All phone-scoped endpoints act through one phone, selected with the x-phone header (org phone number or phone_id).

<ResponseExample>
  ```json The Phone Object theme={null}
  {
    "phone_id": "phone-aaaaaaaaaaaa",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "org_phone": "911111111111@c.us",
    "phone_name": "Support",
    "phone_image": "https://example.com/files/image.png",
    "wa_state": "CONNECTED",
    "is_ready": true,
    "qr_code": null,
    "label_ids": {
      "label-aaaaaaaaaaaa": true
    },
    "labels": [
      "support",
      "priority"
    ],
    "is_browser_open": true,
    "last_disconnect": null,
    "queue_status": null,
    "first_connected_at": "2026-01-15T09:30:00.000Z",
    "created_at": "2026-01-10T12:00:00.000Z",
    "updated_at": "2026-01-15T09:30:00.000Z"
  }
  ```
</ResponseExample>

**Attributes**

<ParamField path="phone_id" type="string">
  Unique id of the phone (phone-xxxxxxxxxxxxxxxx). Accepted as the x-phone header value on phone-scoped endpoints.
</ParamField>

<ParamField path="org_id" type="string">
  Id of the organization the phone belongs to
</ParamField>

<ParamField path="org_phone" type="string">
  WhatsApp number connected to the phone, as country code + number suffixed with @c.us. null until a WhatsApp account has been connected by scanning the QR.
</ParamField>

<ParamField path="phone_name" type="string">
  Display name of the phone
</ParamField>

<ParamField path="phone_image" type="string">
  URL of the profile image of the phone
</ParamField>

<ParamField path="wa_state" type="string">
  WhatsApp connection state — 'CONNECTED' when the session is live, 'UNPAIRED'/'UNPAIRED\_IDLE' while awaiting a QR scan, other transient states include 'OPENING', 'PAIRING', 'TIMEOUT' and 'CONFLICT'. null before the phone has ever connected.
</ParamField>

<ParamField path="is_ready" type="boolean">
  Whether the phone instance is booted and ready to send and receive messages
</ParamField>

<ParamField path="qr_code" type="string">
  Raw QR payload while the phone is awaiting a QR scan; null once connected. Use GET /phones/qr to render it as a scannable image.
</ParamField>

<ParamField path="label_ids" type="object">
  Labels assigned to the phone, keyed by label\_id (true = assigned)
</ParamField>

<ParamField path="labels" type="string[]">
  Names of the labels assigned to the phone, resolved from label\_ids
</ParamField>

<ParamField path="is_browser_open" type="boolean">
  Whether the phone's WhatsApp Web browser session is currently open
</ParamField>

<ParamField path="last_disconnect" type="object">
  Details of the most recent disconnect event, if any. null when the phone has never disconnected.
</ParamField>

<ParamField path="queue_status" type="object">
  Status of the phone's outgoing message queue, if any messages are queued
</ParamField>

<ParamField path="first_connected_at" type="string">
  When a WhatsApp account was first connected to the phone, as an ISO 8601 timestamp. null if never connected.
</ParamField>

<ParamField path="created_at" type="string">
  When the phone was created, as an ISO 8601 timestamp
</ParamField>

<ParamField path="updated_at" type="string">
  When the phone was last updated, as an ISO 8601 timestamp
</ParamField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.