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

# List assignables

`GET /assignables`

Lists the accessible assignables.

## Query parameters

- `per_page` integer — The maximum number of items to show per response page.
- `page` integer — The response page to return.

## Response `200`

The accessible assignables.

- 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
        - `id` integer — Unique identifier for the resource instance.
        - `description` string — Describes the Assignable.
        - `guid` string — Globally Unique Identifier for the resource instance.
        - `name` string — Assignable name.
        - `deleted_at` string, date-time — If set, it's the date and time the Assignable was archived; otherwise, the object is active.
        - `created_at` string, date-time — Assignable creation date.
        - `updated_at` string, date-time — Date of the most recent modification.
        - `type` 'LeaveType' | 'Project' — The object type.
        - `starts_at` string, date — The Assignable's starting date.
        - `ends_at` string, date — The Assignable's ending date.
        - `project_code` string — If the Assignable is a project, it's a code for referencing the project. Otherwise, it's null.
        - `secureurl` string — A secure URL to the Assignable.
        - `secureurl_expiration` string, date-time — The date (in UTC) when the secure URL expires.
        - `timeentry_lockout` integer — If the Assignable is a project, the lockout indicates whether the project locks out new time entries and, if so, the number of days previous that entries are locked. If the Assignable isn't a project, this value is `-1`. Valid values: | **Value** | **Description** | | ------------- | --------------- | | `-1` | Not locked | | `0` | Locked for all entries | | Integer greater than or equal to `1`. For example, 7. | If `7`, for example, then the project is locked for entries more than 7 calendar days older than the date when this value was set. | **Note:** We don't support setting this property to a date. **Note:** A project's [phases](/api/resource_management/openapi/phases) inherit the project's `timeentry_lockout`.
        - `project_state_id` integer — A state ID for the project, if the Assignable is a project. Otherwise, the value is null.
        - `thumbnail` string — A thumbnail image for the project, if the Assignable is a project. Otherwise, the value is null. **Note:** you can't set a thumbnail for a project via the API -- to add a thumbnail, use the application UI.
        - `owner_id` integer — Project owner ID, if the Assignable is a project. Otherwise, the value is null.
        - `owner_name` string — Project owner name, if the Assignable is a project. Otherwise, the value is null.
        - `client` string — Client name, if the Assignable is a project. Otherwise, the value is null.
      - AssignableProject
        - `id` integer — Unique identifier for the resource instance.
        - `description` string — Describes the Assignable.
        - `guid` string — Globally Unique Identifier for the resource instance.
        - `name` string — Assignable name.
        - `deleted_at` string, date-time — If set, it's the date and time the Assignable was archived; otherwise, the object is active.
        - `created_at` string, date-time — Assignable creation date.
        - `updated_at` string, date-time — Date of the most recent modification.
        - `type` 'LeaveType' | 'Project' — The object type.
        - `starts_at` string, date — The Assignable's starting date.
        - `ends_at` string, date — The Assignable's ending date.
        - `project_code` string — If the Assignable is a project, it's a code for referencing the project. Otherwise, it's null.
        - `secureurl` string — A secure URL to the Assignable.
        - `secureurl_expiration` string, date-time — The date (in UTC) when the secure URL expires.
        - `timeentry_lockout` integer — If the Assignable is a project, the lockout indicates whether the project locks out new time entries and, if so, the number of days previous that entries are locked. If the Assignable isn't a project, this value is `-1`. Valid values: | **Value** | **Description** | | ------------- | --------------- | | `-1` | Not locked | | `0` | Locked for all entries | | Integer greater than or equal to `1`. For example, 7. | If `7`, for example, then the project is locked for entries more than 7 calendar days older than the date when this value was set. | **Note:** We don't support setting this property to a date. **Note:** A project's [phases](/api/resource_management/openapi/phases) inherit the project's `timeentry_lockout`.
        - `project_state_id` integer — A state ID for the project, if the Assignable is a project. Otherwise, the value is null.
        - `thumbnail` string — A thumbnail image for the project, if the Assignable is a project. Otherwise, the value is null. **Note:** you can't set a thumbnail for a project via the API -- to add a thumbnail, use the application UI.
        - `owner_id` integer — Project owner ID, if the Assignable is a project. Otherwise, the value is null.
        - `owner_name` string — Project owner name, if the Assignable is a project. Otherwise, the value is null.
        - `client` string — Client name, if the Assignable is a project. Otherwise, the value is null.
        - `archived` boolean — `true` if the project is archived; `false` otherwise.
        - `archived_at` string, date-time — Date the project was archived.
        - `use_parent_bill_rates` boolean — If `true` and the project has a parent project, the project uses the parent project's bill rates.
        - `project_state` 'Confirmed' | 'Tentative' | 'Internal' — Describes the state of the project.

## 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)