---
title: "Returns assignments."
method: GET
path: "/assignments"
tags: ["Assignments"]
---

# Returns assignments.

`GET /assignments`

## 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
- `start` string, date-time
- `end` string, date-time
- `started` string, date-time
- `ended` string, date-time
- `show_archived` boolean
- `employees` integer
- `vehicles` integer
- `tools` integer
- `articles` integer
- `tags` integer
- `project_id` integer
- `customer_address_id` integer
- `title` string
- `state` 'UNPLANNED' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAUSED' | 'DELAYED' | 'DONE'
- `all_day` boolean
- `is_template` boolean
- `source` string
- `source_external_id` string
- `lat` number, float
- `lng` number, float
- `radius` integer

## Response `200`

Assignments list

- union
  - object — Generic paginated response wrapper
    - `data` object[] — Assignments list
      - `id` integer — ID
      - `first_line` string — First line
      - `icon` string — Icon
      - `color` string — Color
      - `contrast_color` 'dark' | 'white' — Contrast color
      - `custom_number` string — Custom number
      - `project_id` integer — Project
      - `customer_address_id` integer — Address
      - `template_id` integer — Appointment template
      - `recurring_rule_id` integer — Repeats
      - `title` string — Name
      - `description` string — Instructions
      - `to_be_documented` string — Task for protocol
      - `internal_info` string — Internal info
      - `start` string, date-time — Start
      - `end` string, date-time — End
      - `all_day` boolean — All day
      - `timezone` string — Time zone
      - `state` 'UNPLANNED' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAUSED' | 'DELAYED' | 'DONE' — Status
      - `is_template` boolean — Appointment template
      - `duration` integer — Scheduled duration
      - `planned_time` integer — Scheduled time
      - `target_time` integer — Target working time
      - `calculated_sales_volume` string — Calculated sales volume
      - `archived_on` string, date-time, nullable — Archived on
      - `reminded_start` boolean — Reminded start
      - `reminded_delayed` boolean — Reminded delayed
      - `source` string — Source
      - `source_external_id` string, nullable — Source ID
      - `created_at` string, date-time — Created
      - `updated_at` string, date-time — Updated
    - `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)