Family Center

Family Center acts as Discord's parental controls solution to allow parents to monitor the activities of their teens on Discord. They do not allow parents to view message content, but Discord does share:

• Users messaged (DMs and Group DMs)
• Users called (DMs and Group DMs) in the last week
• Friends added in the last week
• Guilds joined in the last week
• Guilds the teen has sent messages to in the last week

A maximum of 8 accounts can be connected to a single parent.

Definitions

In line with the API, instead of referring to Family Center users as "parents" or "teens" and links as "family", "connected teens", or "my family", the API terminology will be used instead.

• Requestor: This is the user that sends a link request to a different user and acts as the user the linked user is connected to. Can be viewed as the "parent."
• Linked user: This is the user that receives or accepts a link request sent by the requestor and acts as the user the "parent" can view the activity of. Can be viewed as the "teen."
• Link: Represents the connection between requestor and linked user.

Family Center Object

Family Center Structure

Linked User Object

Partial user data of an underage user linked to the requestor via Family Center.

Linked User Structure

¹ If the link type is 1, the user_id and requestor_id will be the same. See Link Type for more information.

Link Status

Represents the current state of the link.

Link Type

Represents what part each user played in the connection.

Example Linked User

{
  "created_at": "2024-07-30T19:49:09.800072+00:00",
  "updated_at": "2024-07-30T19:55:43.834081+00:00",
  "link_type": 2,
  "link_status": 3,
  "requestor_id": "246877849162743818",
  "user_id": "801318363472330772"
}

Linked Users Object

Lists all linked users and requestors. Not to be confused with the Linked User object.

Linked Users structure

Teen Audit Log Object

Audit log of events of the linked user. Visible to both requestors and linked users.

Teen Audit Log Structure

Action Structure

Teen Action Type

Represents a specific teen action.

Teen Action Display Type

Represents the grouped display type of an action.

Example Teen Audit Log

{
  "teen_user_id": "801318363472330772",
  "range_start_id": "1328607677722394624",
  "actions": [
    {
      "event_id": "1331144363278860318",
      "user_id": "801318363472330772",
      "entity_id": "246877849162743818",
      "display_type": 3
    }
  ],
  "users": [
    {
      "id": "246877849162743818",
      "username": "jay_taelien",
      "global_name": "Jay",
      "avatar": "91b7bc37e924f78625f7ea582fdbac5d",
      "avatar_decoration_data": {
        "asset": "a_aa2e1c2b3cf05b24f6ec7b8b4141f5fc",
        "sku_id": "1144056631374647458",
        "expires_at": null
      },
      "discriminator": "0",
      "public_flags": 16512,
      "primary_guild": null
    }
  ],
  "guilds": [],
  "totals": {
    "1": 0,
    "2": 0,
    "3": 1,
    "4": 0
  }
}

Restricted Schedule Object

A restricted schedule contains time-based access rules for a linked teen.

Restricted Schedule Structure

Restricted Schedule Rule Object

A restricted schedule rule defines a recurring restricted period.

Restricted Schedule Rule Structure

Day Of Week

Time Of Day Object

A time of day identifies a wall-clock time.

Time Of Day Structure

Example Restricted Schedule

{
  "rules": [
    {
      "rule_id": "school-night",
      "label": "School nights",
      "start_time": { "hours": 22, "minutes": 0, "seconds": 0, "nanos": 0 },
      "end_time": { "hours": 7, "minutes": 0, "seconds": 0, "nanos": 0 },
      "days": [1, 2, 3, 4, 5],
      "enabled": true
    }
  ]
}

Endpoints

Returns a Family Center object.

Generates the link code for usage in the generated QR code that a linked user receives to give to a requestor.

Response Body

Returns a linked users object.

Creates a request that appears in the linked user's Family Center. Returns a linked users object on success. Fires a User Update Gateway event.

JSON Params

Modifies the linked user status of a linked user. Can be invoked by either the linked user or the requestor if used for removing the link. Returns an array of linked user objects on success. Fires a User Update Gateway event.

JSON Params

¹ If this request is sent to remove a link (setting link_status to 3), the linked_user_id changes depending on if the requestor or linked user is invoking it. If the linked user invokes the request, linked_user_id is the ID of the requestor, otherwise it's the ID of the linked user.

Removes a linked user. Returns a list of linked user objects on success. Fires a User Update Gateway event.

JSON Params

Returns a Family Center object containing the linked teen's activity.

Returns a Family Center object containing additional activity for the given teen, display type, date range, and event cursor.

Returns the connection prerequisites for a Family Center link.

Query String Params

Modifies family center teen settings.

JSON Params

Returns an object containing the updated settings object on success.

Modifies family center teen consents.

JSON Params

Returns the updated consents object on success.

Creates a restricted-schedule rule for the linked teen. Returns a restricted schedule object on success.

JSON Params

The request body is a restricted schedule rule object.

Modifies a restricted-schedule rule for the linked teen. Returns a restricted schedule object on success.

JSON Params

The request body contains the fields of a restricted schedule rule object to modify.

Deletes a restricted-schedule rule for the linked teen. Returns a restricted schedule object on success.