v1

latestOpenAPI 3.0.02026-08-06151101754.7 KB

Documentations

Returns documentation from a specific assignment

get/documentations

Query parameters

idinteger

Filters by IDs. Multiple inputs with id[]=1&id[]=2

per_pageinteger

Number of items per Page

pageinteger

Result Page

order_bystring

Order column

order_direction'asc' | 'desc'

Order direction. asc or desc possible

returnstring

Returns a single aggregate over the filtered list instead of the paginated result, e.g. {"data": {"count": 42}}. Allowed values: count, sum.column, min.column, max.column, avg.column (e.g. return=sum.duration_seconds). sum and avg require a numeric column.

group_bystring

Returns one aggregate row per bucket of the given column instead of the paginated result, e.g. group_by=type_id gives {"data": [{"type_id": 1, "count": 5}, ...]}. The per-bucket aggregate reuses the "return=" grammar and defaults to count (e.g. group_by=type_id&return=sum.id). Combine with order_by=<aggregate>&order_direction=desc for "top N" queries. Groupable columns are known model columns plus foreign keys. Datetime columns must be bucketed by granularity: group_by=created_at:month (also :year, :day/:date), giving {"data": [{"created_at": "2026-07", "count": 5}, ...]}. Results are capped at 1000 buckets.

withstring

You can load relations using the with parameter. Example for assignments/appointments: with[]=documents loads all related documents and adds it to the response.

excludeinteger

Exclude ids. Multiple inputs with exclude[]=3&exclude[]=6

qstring

Search string

assignment_idinteger

Filter by assignment_id. Multiple inputs with assignment_id[]=1&assignment_id[]=2

author_idinteger

Filter by author_id. Multiple inputs with author_id[]=1&author_id[]=2

titlestring

Filter by title. Multiple inputs with title[]=some&title[]=other

state'ACCEPTED_WITH_COMMENT' | 'ACCEPTED_WO_COMMENT'

Filter by state. Multiple inputs with state[]=DRAFT&state[]=DONE

Filter by type. Multiple inputs with type[]=PHOTO&type[]=NOTE

sourcestring

Filter by source. Multiple inputs with source[]=api&source[]=app

source_external_idstring

Filter by source_external_id. Multiple inputs with source_external_id[]=123&source_external_id[]=456

Response

Documentations list

Example response

{
  "data": [
    {
      "id": 1,
      "assignment_id": 1,
      "author_id": 1,
      "upload_id": 1,
      "upload2_id": 1,
      "title": "Title",
      "description": "Description",
      "type": "note",
      "state": "done",
      "first_line": "First line",
      "icon": "fas fa-file",
      "color": "#000000",
      "contrast_color": "WHITE"
    }
  ]
}