Skip to main content
GET
/
v1
/
phones
List Phones
curl --request GET \
  --url https://api.wellapp.ai/v1/phones
{
  "data": [
    {
      "type": "phone",
      "id": "uuid",
      "attributes": {}
    }
  ],
  "meta": {
    "total": 0,
    "count": 0
  },
  "links": {
    "next": null
  }
}
Filter and sort on a related (included) object by nesting into the relationship — the same relationships you pass to include.
  • To-one relations nest directly: { "issuer": { "name": { "_eq": "Acme" } } }, and sort by a dot-path: "orderBy": { "field": "issuer.name", "direction": "asc" }.
  • To-many relations must be quantified with _some, _every, or _none: { "items": { "_some": { "quantity": { "_gt": 1 } } } }. They are not directly sortable (a to-many sort needs an aggregate proxy).
  • Composite composite_* columns are virtual — filter and sort on their underlying source fields, not on the composite.
Workspace row-level security applies at every hop, so a related-object filter never widens your tenant scope. Full operator set, deep-nesting rules, and pagination notes: Filtering & sorting. This resource’s related objects (the ones you can include) and how to filter or sort on each:
RelationshipCardinalityFilter on a fieldSort by a field
workspaceto-one (workspace){ "workspace": { "name": { "_eq": … } } }"field": "workspace.name" ✅
person_phonesto-many (person_phone){ "person_phones": { "_some": { "field_name": { "_eq": … } } } }aggregate proxy only ⚠️
company_phonesto-many (company_phone){ "company_phones": { "_some": { "field_name": { "_eq": … } } } }aggregate proxy only ⚠️
Replace field_name with any field of the related object. See its object-reference page for the full field list. Filter by a to-one relation (and sort by it): 
{
  "root": "phones",
  "whereClause": { "workspace": { "name": { "_ilike": "%acme%" } } },
  "orderBy": { "field": "workspace.name", "direction": "asc" }
}
Filter by a to-many relation (quantified — bare nesting is invalid): 
{
  "root": "phones",
  "whereClause": { "person_phones": { "_some": { "field_name": { "_gt": 0 } } } }
}

Query Parameters

​
limit
integer
default:50

Page size (max 200).

Required range: x <= 200
​
cursor
string

Opaque keyset cursor; omit for the first page.

​
orderBy
string

Field to order by.

​
direction
enum<string>
Available options:
asc,
desc
​
workspaceId
string<uuid>

Optional explicit workspace scope (Firebase-authenticated callers).

Response

A page of phone records.