---
title: "Returns a specific assignment"
method: GET
path: "/assignments/{assignmentId}"
tags: ["Assignments"]
---

# Returns a specific assignment

`GET /assignments/{assignmentId}`

## Path parameters

- `assignmentId` integer, required

## Response `200`

Assignment

- object
  - `data` Assignment — An assignment object. Available relations: customer_address, project, customer, template, assignments, documents, recurring_rule, documentations, signing_documentations, recorded_times, employees, observers, vehicles, tools, articles, tags, timesheet_activities, billable_timesheet_activities, address, changelog
    - `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

## Other responses

- `401` — The request lacks valid authentication credentials.
- `403` — The token is valid but lacks the permission for this action.
- `404` — The requested resource could not be found.
- `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/versions/c01f07a02f77/schema)