v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

phones

Get All Phones

This endpoint retrieves a list of all phones associated with this account

Response

The response is a JSON array of phone objects. Refer to the phone object here

get/phones/all

Response

200 OK

created_atstring

first_connected_atstring

is_readyboolean

org_idstring

org_phonestring

phone_idstring

phone_imagestring

phone_namestring

{"stackTrail":"paths:/phones/all:get:responses:200:content:application/json:schema:items:properties:qr_code","oasType":"schema","type":"unknown","example":null,"nullable":true}

updated_atstring

wa_statestring

Example response

[
  {
    "created_at": "2024-12-31T17:51:15.977006+00:00",
    "first_connected_at": "2025-01-16T18:31:43.921+00:00",
    "is_ready": true,
    "label_ids": {},
    "labels": [],
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "919971844008@c.us",
    "phone_id": "phone-njjnpbeheymosvlo",
    "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919971844008%40c.us.jpg?timestamp=1737098940409",
    "phone_name": "Periskope",
    "qr_code": null,
    "updated_at": "2025-01-17T08:44:02.6+00:00",
    "wa_state": "CONNECTED"
  },
  {
    "created_at": "2024-12-15T11:47:26.668505+00:00",
    "first_connected_at": "2024-12-15T11:47:49.649+00:00",
    "is_ready": true,
    "label_ids": {
      "label-bflirzqiodgianfh": true,
      "label-rbdshklasmlbfczf": true
    },
    "labels": [
      "test1",
      "test2"
    ],
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us",
    "phone_id": "phone-bqzvyibhmwkaergr",
    "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737141384215",
    "phone_name": "Support",
    "qr_code": null,
    "updated_at": "2025-01-20T07:51:48.209+00:00",
    "wa_state": "CONNECTED"
  }
]