---
title: "Returns documentation from a specific assignment"
method: GET
path: "/documentations"
tags: ["Documentations"]
---

# Returns documentation from a specific assignment

`GET /documentations`

## Query parameters

- `id` integer
- `per_page` integer
- `page` integer
- `order_by` string
- `order_direction` 'asc' | 'desc'
- `return` string
- `group_by` string
- `with` string
- `exclude` integer
- `q` string
- `assignment_id` integer
- `author_id` integer
- `title` string
- `state` 'ACCEPTED_WITH_COMMENT' | 'ACCEPTED_WO_COMMENT'
- `type` 'NOTE' | 'DRAFT' | 'PHOTO' | 'SIGNING' | 'TIME' | 'PDF' | 'ATTACHMENT' | 'MATERIAL'
- `source` string
- `source_external_id` string

## Response `200`

Documentations list

- union
  - object — Generic paginated response wrapper
    - `data` object[] — Documentations list
      - `id` integer — ID
      - `assignment_id` integer — Assignment
      - `author_id` integer — Author
      - `upload_id` integer — File
      - `upload2_id` integer — File
      - `title` string — Title
      - `description` string — Description
      - `type` 'NOTE' | 'DRAFT' | 'PHOTO' | 'SIGNING' | 'TIME' | 'PDF' | 'ATTACHMENT' | 'MATERIAL' — Type
      - `state` 'ACCEPTED_WITH_COMMENT' | 'ACCEPTED_WO_COMMENT' — State
      - `first_line` string — First line
      - `icon` string — Icon
      - `color` string — Color
      - `contrast_color` 'dark' | 'white' — Contrast color
      - `documented_on` string, date-time — Documented on
      - `created_at` string, date-time — Created at
      - `updated_at` string, date-time — Updated at
    - `links` object
      - `first` string, nullable
      - `last` string, nullable
      - `prev` string, nullable
      - `next` string, nullable
    - `meta` object
      - `current_page` integer
      - `from` integer, nullable
      - `last_page` integer
      - `links` object[]
        - `url` string, nullable
        - `label` string
        - `active` boolean
      - `path` string
      - `per_page` integer
      - `to` integer, nullable
      - `total` integer
  - AggregateResponse — Returned instead of the paginated list when the "return=" parameter is used.
    - `data` object
      - `count` integer — Response envelope for the "return=" aggregate parameter (see general--return). Exactly one of the properties is present per response, depending on the requested aggregate.
      - `sum` number, nullable
      - `avg` number, nullable
      - `min` unknown
      - `max` unknown
  - GroupedAggregateResponse — Returned instead of the paginated list when the "group_by=" parameter is used. One row per bucket.
    - `data` object[]
      - `count` integer — Response envelope for the "group_by=" parameter (see general--group_by). Each element is one bucket: the grouped column plus the requested aggregate (count by default, or one of sum/min/max/avg via "return=").
      - `sum` number, nullable
      - `avg` number, nullable
      - `min` unknown
      - `max` unknown

## Other responses

- `401` — The request lacks valid authentication credentials.
- `403` — The token is valid but lacks the permission for this action.
- `500` — An unexpected error occurred on the server (e.g. a requested relation does not exist).

---

[API](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation.md) · [All operations](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/craftboxx/craftboxx-api-documentation/revisions/c01f07a02f77/schema)