---
title: "Returns SpanAnnotationSearch."
method: POST
path: "/search/span_annotation"
tags: ["search"]
---

# Returns SpanAnnotationSearch.

`POST /search/span_annotation`

## Query parameters

- `project_id` integer, required
- `page` integer, nullable
- `page_size` integer, nullable

## Request body

- BodySearchSearchSpanAnnotations
  - `filter` FilterSpanColumnsInput, required
    - `id` string, required
    - `items` union[], required
      - union
        - FilterExpressionSpanColumns
          - `id` string, required
          - `column` union, required
            - 'SP_SPAN_TEXT' | 'SP_CODE_ID' | 'SP_USER_ID' | 'SP_MEMO_CONTENT' | 'SP_SOURCE_SOURCE_DOCUMENT_NAME' | 'SP_TAG_ID_LIST_RECURSIVE' | 'SP_FOLDER_ID_LIST_RECURSIVE'
            - integer
          - `operator` union, required
            - 'ID_EQUALS' | 'ID_NOT_EQUALS'
            - 'NUMBER_EQUALS' | 'NUMBER_NOT_EQUALS' | 'NUMBER_GT' | 'NUMBER_LT' | 'NUMBER_GTE' | 'NUMBER_LTE'
            - 'STRING_CONTAINS' | 'STRING_EQUALS' | 'STRING_NOT_EQUALS' | 'STRING_STARTS_WITH' | 'STRING_ENDS_WITH'
            - 'ID_LIST_CONTAINS' | 'ID_LIST_NOT_CONTAINS'
            - 'IDLR_CONTAINS' | 'IDLR_NOT_CONTAINS' | 'IDLR_CONTAINS_RECURSIVE'
            - 'LIST_CONTAINS' | 'LIST_NOT_CONTAINS'
            - 'DATE_EQUALS' | 'DATE_GT' | 'DATE_LT' | 'DATE_GTE' | 'DATE_LTE'
            - 'BOOLEAN_EQUALS' | 'BOOLEAN_NOT_EQUALS'
          - `value` union, required
            - boolean
            - string
            - integer
            - string[]
            - array[]
              - …
        - FilterSpanColumnsInput — recursive
    - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
  - `sorts` SortSpanColumns[], required
    - `column` union, required
      - 'SP_SPAN_TEXT' | 'SP_CODE_ID' | 'SP_USER_ID' | 'SP_MEMO_CONTENT' | 'SP_SOURCE_SOURCE_DOCUMENT_NAME' | 'SP_TAG_ID_LIST_RECURSIVE' | 'SP_FOLDER_ID_LIST_RECURSIVE'
      - integer
    - `direction` 'asc' | 'desc', required

## Response `200`

Successful Response

- SpanAnnotationSearchResult
  - `total_results` integer, required — The total number of span_annotation_ids. Used for pagination.
  - `data` SpanAnnotationRow[], required — The Annotations.
    - `id` integer, required — ID of the SpanAnnotation
    - `span_text` string, required — The SpanText the SpanAnnotation spans.
    - `code` CodeRead, required
      - `name` string, required — Name of the Code
      - `color` string, required — Color of the Code
      - `description` string — Description of the Code
      - `parent_id` integer, nullable — Parent of the Code
      - `enabled` boolean — While false, the code is neither created in pre-processing nor shown in the UI (except in settings to enable it again)
      - `id` integer, required — ID of the Code
      - `project_id` integer, required — Project the Code belongs to
      - `created` string, date-time, required — Created timestamp of the Code
      - `updated` string, date-time, required — Updated timestamp of the Code
      - `is_system` boolean, required — Is the Code a system code
      - `memo_ids` integer[], required — Memo IDs attached to the Code
    - `user_id` integer, required — User the SpanAnnotation belongs to
    - `sdoc` SourceDocumentRead, required
      - `filename` string, required — Filename of the SourceDocument
      - `name` string, required — User-defined name of the document (default is the filename)
      - `doctype` 'text' | 'image' | 'video' | 'audio', required
      - `project_id` integer, required — Project the SourceDocument belongs to
      - `id` integer, required — ID of the SourceDocument
      - `created` string, date-time, required — The created timestamp of the SourceDocument
      - `updated` string, date-time, required — Updated timestamp of the SourceDocument
      - `folder_id` integer, required — ID of the Folder this SourceDocument belongs to
      - `memo_ids` integer[] — IDs of the Memos attached to the SourceDocument
    - `tag_ids` integer[], required — The TagIDs of the SourceDocument.
    - `memo_ids` integer[], required — The IDs of the Memos attached to the Annotation.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api.md) · [All operations](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uhh-lt/discourse-analysis-tool-suite-api/versions/6b22366ce2d1/schema)