Get Phones
get
/v1/phones/{phone_id}Fetches a single phone row by id from the records pipeline, scoped to the workspace. Read-only; no side effects. 404 when the phone is absent or out of scope.
Requires a bearer token: Authorization: Bearer <token>.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| phone_id | string <uuid> | Yes | Public UUID of the phone.e.g. f7a8b9c0-1d2e-43f4-95a6-b7c8d9e0f1a2 |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string <uuid> | No | Workspace to scope to; defaults to the token's workspace.e.g. 8f6b2c10-4a1e-4d2b-9c3a-1f0e7a5b6c21 |
Request
cURL
curl -X GET https://api.wellapp.ai/v1/phones/{phone_id} \
-H "Authorization: Bearer $WELL_API_TOKEN"Responses
200 — The phone row.
{
"data": {
"type": "phone",
"id": "f7a8b9c0-1d2e-43f4-95a6-b7c8d9e0f1a2",
"attributes": {
"country_code": 1,
"national_number": "4155550142",
"e164_number": "+14155550142"
},
"relationships": {
"person_phones": {
"data": [
{
"type": "person_phone",
"id": "00000000-0000-4000-8000-000000000001"
}
]
},
"company_phones": {
"data": [
{
"type": "company_phone",
"id": "00000000-0000-4000-8000-000000000001"
}
]
}
}
}
}401 — Unauthorized
{
"code": "UNAUTHORIZED",
"status": 401,
"title": "Unauthorized",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}403 — Forbidden
{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}404 — Not Found
{
"code": "NOT_FOUND",
"status": 404,
"title": "Not Found",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}