---
title: "Phones.get"
method: GET
path: "/entities/Phones/{id}"
tags: ["Phone"]
---

# Phones.get

`GET /entities/Phones/{id}`

Returns Phone with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

Phone data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Phone
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `owner` string, uri — User the phone is assigned to, when the phone belongs to a specific user (personal calling/SMS line). Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `error_code` integer — Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy.
    - `name` string, required — Name of the entity and its default text representation.
    - `owner_id` string, uuid — Id of the assigned user, or empty when the phone is a company-level resource.
    - `phone_number` string — Phone number in E.164 format (e.g. "+12025550123").
    - `twilio_caller_sid` string — External caller identifier from the calling provider (e.g. Twilio caller SID).
    - `type` 1 | 2 | 3 | 4 | 5 | 6, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany
    - `revision` integer — Revision when entity was lastly changed.
    - `message_forwarding_email` string — Email address that incoming text messages to this phone are forwarded to. Empty when forwarding is not configured.
    - `call_forwarding_phone` string — Phone number that incoming calls/SMS to this phone are forwarded to. Empty when forwarding is not configured.
    - `enabled` boolean, required — False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)