NationGraph Notes API

openapi: 3.1.0
info:
  title: Nationgraph Accounts Notes API
  version: 0.2.36
tags:
- name: Notes
paths:
  /api/v3/workspaces/{workspace_id}/institution/{institution_id}/notes:
    post:
      tags:
      - Notes
      summary: Insert Note
      description: 'Upsert a note for an institution.

        This endpoint first ensures a ''note'' custom column exists for the workspace.'
      operationId: insert_note_api_v3_workspaces__workspace_id__institution__institution_id__notes_post
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Id
      - name: institution_id
        in: path
        required: true
        schema:
          type: string
          title: Institution Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Notes
      summary: Get Notes By Institution
      description: Get all notes attributed to an institution.
      operationId: get_notes_by_institution_api_v3_workspaces__workspace_id__institution__institution_id__notes_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Id
      - name: institution_id
        in: path
        required: true
        schema:
          type: string
          title: Institution Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v3/notes:
    put:
      tags:
      - Notes
      summary: Update Note
      description: Update an existing note.
      operationId: update_note_api_v3_notes_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v3/notes/{note_id}:
    delete:
      tags:
      - Notes
      summary: Delete Note
      description: Delete a note by id.
      operationId: delete_note_api_v3_notes__note_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: note_id
        in: path
        required: true
        schema:
          type: string
          title: Note Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NoteRequest:
      properties:
        content:
          type: string
          title: Content
        id:
          anyOf:
          - type: string
          - type: 'null'
          title: Id
      type: object
      required:
      - content
      title: NoteRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer