---
title: "List assignments"
method: GET
path: "/assignments"
tags: ["assignments"]
---

# List assignments

`GET /assignments`

Lists the accessible assignments.

## Query parameters

- `per_page` integer — The maximum number of items to show per response page.
- `page` integer — The response page to return.
- `from` string, date
- `to` string, date
- `with_phases` boolean

## Response `200`

The accessible assignments.

- object
  - `paging` PagingMetadata, required
    - `per_page` integer — The maximum number of items to show per response page.
    - `page` integer — The current response page number.
    - `previous` string, nullable — If you're on the first page, this value is `null`; otherwise the value is the path and query parameters to get the previous page of items.
    - `self` string — The path and query parameters to get the current page of items.
    - `next` string, nullable — If there are more items, this value is the path and query parameters to get the next page of items; otherwise, it's `null`.
    - `count` integer, nullable — The total number of items in all the pages.
  - `data` union[], required
    - union
      - object — An assignment set to a percentage of the resource's time.
        - `allocation_mode` 'percent', required — This indicates that a percentage of the resource's time is allocated to the corresponding assignment.
        - `percent` number, required — The percentage of time the resource is allocated to the corresponding assignment. **Note:** This property is only present when `allocation_mode` is `"percent"`.
        - `id` integer — The unique identifier for the assignment.
        - `user_id` integer — The ID of the user this assignment belongs to.
        - `assignable_id` integer — The ID of the project, phase, or leave type to which the the assignment applies.
        - `starts_at` string, date, required — The assignment's effective start date.
        - `ends_at` string, date, required — The assignment's effective end date.
        - `repetition_id` integer, nullable — A unique identifier for a series of repeating assignments. If the assignment is part of a repeating series, this is the parent assignment's unique ID. Otherwise, it's null. **Note:** This ID is the same for all assignments within the same repeating series.
        - `created_at` string, date-time — The time of creation.
        - `updated_at` string, date-time — The time of the last update.
        - `all_day_assignment` boolean
        - `resource_request_id` integer, nullable
        - `bill_rate` number, nullable — The cost value.
        - `bill_rate_id` integer, nullable
        - `status` unknown
        - `status_option_id` integer, nullable — The ID of the status option associated with the assignment.
        - `description` string — Describes the assignment.
        - `note` boolean, nullable — Calls out ancillary information about the assignment.
        - `subtasks` object
          - `paging` PagingMetadata
            - `per_page` integer — The maximum number of items to show per response page.
            - `page` integer — The current response page number.
            - `previous` string, nullable — If you're on the first page, this value is `null`; otherwise the value is the path and query parameters to get the previous page of items.
            - `self` string — The path and query parameters to get the current page of items.
            - `next` string, nullable — If there are more items, this value is the path and query parameters to get the next page of items; otherwise, it's `null`.
            - `count` integer, nullable — The total number of items in all the pages.
          - `data` Subtask[]
            - `id` integer — The unique identifier for the subtask.
            - `assignment_id` integer — The ID of the assignment to which this subtask belongs.
            - `assignable_id` integer — The ID of the project, phase, or leave type to which the the assignment applies.
            - `description` string — Identifies the subtask.
            - `completed` boolean — This is true if the subtask is done; otherwise, it's false.
            - `updated_at` string, date-time — The time of the last update.
            - `created_at` string, date-time — The time of creation.
            - `updated_by` integer — The ID of the user who last updated this subtask.
      - object — An assignment set for a fixed number of hours.
        - `allocation_mode` 'fixed_hours', required — This indicates that a fixed number of the resource's hours is allocated to the corresponding assignment.
        - `fixed_hours` number, required — The number of hours the resource is allocated to a corresponding assignment. **Note:** This property is only present when `allocation_mode` is `"fixed_hours"`.
        - `id` integer — The unique identifier for the assignment.
        - `user_id` integer — The ID of the user this assignment belongs to.
        - `assignable_id` integer — The ID of the project, phase, or leave type to which the the assignment applies.
        - `starts_at` string, date, required — The assignment's effective start date.
        - `ends_at` string, date, required — The assignment's effective end date.
        - `repetition_id` integer, nullable — A unique identifier for a series of repeating assignments. If the assignment is part of a repeating series, this is the parent assignment's unique ID. Otherwise, it's null. **Note:** This ID is the same for all assignments within the same repeating series.
        - `created_at` string, date-time — The time of creation.
        - `updated_at` string, date-time — The time of the last update.
        - `all_day_assignment` boolean
        - `resource_request_id` integer, nullable
        - `bill_rate` number, nullable — The cost value.
        - `bill_rate_id` integer, nullable
        - `status` unknown
        - `status_option_id` integer, nullable — The ID of the status option associated with the assignment.
        - `description` string — Describes the assignment.
        - `note` boolean, nullable — Calls out ancillary information about the assignment.
        - `subtasks` object
          - `paging` PagingMetadata
            - `per_page` integer — The maximum number of items to show per response page.
            - `page` integer — The current response page number.
            - `previous` string, nullable — If you're on the first page, this value is `null`; otherwise the value is the path and query parameters to get the previous page of items.
            - `self` string — The path and query parameters to get the current page of items.
            - `next` string, nullable — If there are more items, this value is the path and query parameters to get the next page of items; otherwise, it's `null`.
            - `count` integer, nullable — The total number of items in all the pages.
          - `data` Subtask[]
            - `id` integer — The unique identifier for the subtask.
            - `assignment_id` integer — The ID of the assignment to which this subtask belongs.
            - `assignable_id` integer — The ID of the project, phase, or leave type to which the the assignment applies.
            - `description` string — Identifies the subtask.
            - `completed` boolean — This is true if the subtask is done; otherwise, it's false.
            - `updated_at` string, date-time — The time of the last update.
            - `created_at` string, date-time — The time of creation.
            - `updated_by` integer — The ID of the user who last updated this subtask.
      - object — An assignment set to hours per day.
        - `allocation_mode` 'hours_per_day', required — This indicates that a number of the resource's daily hours is allocated to the corresponding assignment.
        - `hours_per_day` number, required — The number of hours per day that the resource is allocated to a corresponding assignment. **Note:** This property is only present when `allocation_mode` is `"hours_per_day"`.
        - `id` integer — The unique identifier for the assignment.
        - `user_id` integer — The ID of the user this assignment belongs to.
        - `assignable_id` integer — The ID of the project, phase, or leave type to which the the assignment applies.
        - `starts_at` string, date, required — The assignment's effective start date.
        - `ends_at` string, date, required — The assignment's effective end date.
        - `repetition_id` integer, nullable — A unique identifier for a series of repeating assignments. If the assignment is part of a repeating series, this is the parent assignment's unique ID. Otherwise, it's null. **Note:** This ID is the same for all assignments within the same repeating series.
        - `created_at` string, date-time — The time of creation.
        - `updated_at` string, date-time — The time of the last update.
        - `all_day_assignment` boolean
        - `resource_request_id` integer, nullable
        - `bill_rate` number, nullable — The cost value.
        - `bill_rate_id` integer, nullable
        - `status` unknown
        - `status_option_id` integer, nullable — The ID of the status option associated with the assignment.
        - `description` string — Describes the assignment.
        - `note` boolean, nullable — Calls out ancillary information about the assignment.
        - `subtasks` object
          - `paging` PagingMetadata
            - `per_page` integer — The maximum number of items to show per response page.
            - `page` integer — The current response page number.
            - `previous` string, nullable — If you're on the first page, this value is `null`; otherwise the value is the path and query parameters to get the previous page of items.
            - `self` string — The path and query parameters to get the current page of items.
            - `next` string, nullable — If there are more items, this value is the path and query parameters to get the next page of items; otherwise, it's `null`.
            - `count` integer, nullable — The total number of items in all the pages.
          - `data` Subtask[]
            - `id` integer — The unique identifier for the subtask.
            - `assignment_id` integer — The ID of the assignment to which this subtask belongs.
            - `assignable_id` integer — The ID of the project, phase, or leave type to which the the assignment applies.
            - `description` string — Identifies the subtask.
            - `completed` boolean — This is true if the subtask is done; otherwise, it's false.
            - `updated_at` string, date-time — The time of the last update.
            - `created_at` string, date-time — The time of creation.
            - `updated_by` integer — The ID of the user who last updated this subtask.

## Other responses

- `default` — Generic error payload

---

[API](https://skmtc.net/smartsheet/apis/resource-management-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/resource-management-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/resource-management-openapi-reference/versions/e4c439ac13f2/schema)