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

# Hide or unhide an account

> Soft-hides or restores an account. Hidden accounts are excluded from category pickers and the default `GET /api/accounts` response, but remain in ledger history and journal entries. Use this to clean up the chart of accounts without losing historical postings.



## OpenAPI

````yaml /openapi.json patch /api/accounts/{id}/settings
openapi: 3.1.0
info:
  title: Equated API
  version: 1.0.0
  description: >-
    Agent-facing accounting API. Authenticate with a bearer token issued from
    Settings → API Tokens, or via the in-app session cookie when called from the
    web client.
servers:
  - url: https://app.equated.co
    description: API server
security: []
paths:
  /api/accounts/{id}/settings:
    patch:
      tags:
        - Accounts
      summary: Hide or unhide an account
      description: >-
        Soft-hides or restores an account. Hidden accounts are excluded from
        category pickers and the default `GET /api/accounts` response, but
        remain in ledger history and journal entries. Use this to clean up the
        chart of accounts without losing historical postings.
      parameters:
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - active
                    - hidden
              required:
                - status
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  category:
                    $ref: '#/components/schemas/Account'
                required:
                  - category
      security:
        - bearerAuth: []
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        key:
          type: string
        name:
          type: string
        type:
          type: string
        parentId:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        kind:
          type: string
          enum:
            - group
            - category
        emoji:
          type: string
          nullable: true
        color:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        registerKind:
          type: string
          nullable: true
          enum:
            - clearing
            - bank
            - null
        bankAccount:
          type: object
          nullable: true
          properties:
            id:
              type: integer
              minimum: 0
              exclusiveMinimum: true
            feedType:
              type: string
            institutionName:
              type: string
              nullable: true
            institutionLogo:
              type: string
              nullable: true
            institutionUrl:
              type: string
              nullable: true
            isoCurrencyCode:
              type: string
              nullable: true
          required:
            - id
            - feedType
            - institutionName
            - institutionLogo
            - institutionUrl
            - isoCurrencyCode
          additionalProperties:
            nullable: true
      required:
        - id
        - key
        - name
        - type
        - parentId
        - kind
        - bankAccount
      additionalProperties:
        nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token issued from the Equated app under Settings → API Tokens.

````