> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rotascale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Families

> What this jurisdiction looks for, and what it cannot see.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/personal-data/families
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/personal-data/families:
    get:
      tags:
        - Personal data
      summary: Families
      description: >-
        What this jurisdiction looks for, and what it cannot see.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: families_v1_personal_data_families_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilityOut'
      security:
        - bearerToken: []
components:
  schemas:
    CapabilityOut:
      properties:
        market_profile:
          type: string
          title: Market Profile
        packs:
          items:
            type: string
          type: array
          title: Packs
        families:
          items:
            $ref: '#/components/schemas/FamilyOut'
          type: array
          title: Families
        not_looked_for:
          items:
            type: string
          type: array
          title: Not Looked For
      type: object
      required:
        - market_profile
        - packs
        - families
        - not_looked_for
      title: CapabilityOut
    FamilyOut:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        pack:
          type: string
          title: Pack
        verifiable:
          type: boolean
          title: Verifiable
        checked_where:
          items:
            type: string
          type: array
          title: Checked Where
          default: []
        active_here:
          type: boolean
          title: Active Here
        obligation:
          type: string
          title: Obligation
      type: object
      required:
        - key
        - title
        - pack
        - verifiable
        - active_here
        - obligation
      title: FamilyOut
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.