---
title: "Family"
method: GET
path: "/v1/family"
tags: ["Owner"]
---

# Family

`GET /v1/family`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/family`
- Auth: HTTP bearer

## Response `200`

OK

- FamilyResponse
  - `members` SetFamilyAlertsResponse[], required
    - `ownerId` string, required
    - `name` string, required
    - `line` 'setting_up' | 'no_number' | 'not_on' | 'on' | 'messages_only' | 'off', required
    - `stoppedWeek` integer, required
    - `lastStoppedAt` string, date-time, required
    - `need` 'setup' | 'plan' | 'line' | 'questions', nullable, required
    - `questions` integer, required
    - `alerts` 'all' | 'urgent' | 'weekly', required
    - `alertsAllowed` boolean, required
    - `permissions` object, required
      - `settings` boolean, required
      - `billing` boolean, required
      - `alerts_scam_urgent` boolean, required
      - `see_caller_content` boolean, required
      - `answer_questions` boolean, required
    - `managing` boolean, required
  - `self` object, nullable, required
    - `ownerId` string, required
    - `stoppedWeek` integer, required
  - `shield` object, required
    - `numbers` integer, required
    - `turnedAway` integer, required
    - `recent` object[], required
      - `name` string, required
      - `you` boolean, required
      - `at` string, date-time, required
      - `shielded` integer, required
      - `turnedAway` integer, required
  - `canAdd` boolean, required
  - `addLanguage` string, nullable, required

## Other responses

- `401`: Missing, expired or invalid bearer token.
- `500`: Unexpected server error (reported to Sentry).

---

[API](https://skmtc.dev/vicem/apis/vicem-api.md) · [All operations](https://skmtc.dev/vicem/apis/vicem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vicem/apis/vicem-api/revisions/9efcec07e5f4?raw)