# List phases

Lists the accessible project phases.

Endpoint: GET /projects/{project_id}/phases
Version: v1
Security: AuthToken

## Header parameters:

  - `Content-Type` (string, required)
    Enum: "application/json"

## Path parameters:

  - `project_id` (integer, required)
    Unique identifier of the parent project instance.
    Example: 1234567

## Query parameters:

  - `from` (string)
    Get projects that end on or after this date.

  - `to` (string)
    Get projects that start on or before this date.

  - `strict` (boolean)
    Set to true to restrict the projects to only those contained entirely within the from and to params.
    Example: true

  - `fields` (string)
    A comma-separated list (no spaces) of additional fields to include with each project in the response. Here are the optional values: "tags", "budget_items", "project_state" , "summary", "custom_field_values"
    Example: "tags,custom_field_values,budget_items,project_state,summary,custom_field_values"

  - `filter_field` (string)
    Specifies the property to filter on. "project_state" is the only supported value.
    Enum: "project_state"

  - `filter_list` (string)
    The value of "filter_field" to match, outputs will be projects with state matching this value. Possible values: Internal, Tentative, Confirmed

  - `sort_field` (string)
    A project field on which to sort the projects in the response.
    Enum: "created", "updated"

  - `sort_order` (string)
    The order for sorting the results based on the sort_field.
    Enum: "ascending", "descending"

  - `project_code` (string)
    Project code to match exactly.

  - `phase_name` (string)
    Phase name to match exactly.

  - `with_archived` (boolean)
    If set to true, includes archived projects.
    Example: true

  - `archived` (boolean)
    Set to true` to include archived projects.

  - `per_page` (integer)
    The maximum number of items to show per response page.
    Example: 100

  - `page` (integer)
    The response page to return.
    Example: 2

## Response 200 fields (application/json):

  - `paging` (object, required)

  - `paging.per_page` (integer)
    The maximum number of items to show per response page.
    Example: 100

  - `paging.page` (integer)
    The current response page number.
    Example: 1

  - `paging.previous` (string,null)
    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.
    Example: "/api/v1/users?per_page=1000&page=1"

  - `paging.self` (string)
    The path and query parameters to get the current page of items.
    Example: "/api/v1/users?per_page=1000&page=2"

  - `paging.next` (string,null)
    If there are more items, this value is the path and query parameters to get the next page of items; otherwise, it's null.
    Example: "/api/v1/users?per_page=1000&page=3"

  - `paging.count` (integer,null)
    The total number of items in all the pages.

  - `data` (array, required)

  - `data.id` (integer)
    Unique identifier for the resource instance.
    Example: 821065

  - `data.archived` (boolean)
    true if the project is archived; false otherwise.

  - `data.archived_at` (string)
    Date the project was archived.

  - `data.description` (string)
    Describes the project.
    Example: "Big pool in a small backyard."

  - `data.guid` (string)
    Globally Unique Identifier for the resource instance.
    Example: "d9d0de8f-32cc-4c0b-8af1-648ce039e3f6"

  - `data.name` (string)
    Project name.
    Example: "PR001: Example Project"

  - `data.parent_id` (integer,null)
    If the object is a Project, this value is null. Otherwise, this value is the ID of the parent project.

  - `data.project_code` (string)
    A code for referencing the project.
    Example: "PR001"

  - `data.secureurl` (string)
    A secure URL to the project.
    Example: "https://smartsheet.com/some/path"

  - `data.secureurl_expiration` (string)
    The date (in UTC) when the secure URL expires.
    Example: "3000-01-01T00:00:00Z"

  - `data.timeentry_lockout` (integer)
    The lockout indicates whether the project locks out new time entries and, if so, the number of days previous that entries are locked.

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.

  - `data.ends_at` (string)
    The project's ending date.
    Example: "2025-05-29"

  - `data.starts_at` (string)
    The project's starting date.
    Example: "2025-01-27"

  - `data.deleted_at` (string)
    If set, it's the date and time the project was archived; otherwise, the project is active.

  - `data.created_at` (string)
    Project creation date.
    Example: "2025-01-22T06:00:30Z"

  - `data.updated_at` (string)
    Date of the most recent modification.
    Example: "2025-01-22T06:13:40Z"

  - `data.use_parent_bill_rates` (boolean)
    If true and the project has a parent project, the project uses the parent project's bill rates.

  - `data.type` (string)
    The object type.
    Example: "Project"

  - `data.project_state_id` (integer)
    Example: 8544040

  - `data.thumbnail` (string)
    A thumbnail image for the project.

Note: you can't set a thumbnail for a project via the API -- to add a thumbnail, use the application UI.
    Example: "https://10kftprojectimages.s3.amazonaws.com/a62ffd30-316f-4cb6-9c7f-eca45d07a35d/499af1a7-bc6b-446f-8535-4472e6159246.png"

  - `data.owner_id` (integer)
    Project owner ID.
    Example: 11223344

  - `data.owner_name` (string)
    Project owner name.

  - `data.phase_count` (integer)

  - `data.phase_name` (string)
    Name of the phase.

  - `data.has_pending_updates` (boolean)
    true if the project has pending updates; false otherwise.

  - `data.client` (string)
    Client name.
    Example: "Your Client"

  - `data.project_state` (string)
    Describes the state of the project.
    Enum: "Confirmed", "Tentative", "Internal"

  - `data.tags` (object)

  - `data.custom_field_values` (object)
    Note: This property is only included in responses if the fields query parameter includes custom_field_values.

  - `data.bounding_startdate` (string)
    The earliest date (start date or date) across all project-related activities and data, including assignables, expense items, assignments, and time entries. The date may precede the project start date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-01-01"

  - `data.bounding_enddate` (string)
    The latest date (end date or date) across all project-related activities and data, including assignables, expense items, assignments, and time entries. The date may follow the project end date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-07-01"

  - `data.bounding_startdate_assignables` (string)
    The earliest start date of all phases (if any) in the project. The date may precede the project start date. If there are no phases, this date is the project start date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-01-01"

  - `data.bounding_enddate_assignables` (string)
    The latest end date of all phases (if any) in the project. The date may follow the project end date. If there are no phases, this date is the project end date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-07-01"

  - `data.bounding_startdate_expense_items` (string)
    The earliest date of all expense items (if any) in the project. The date may precede the project start date. 

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-01-01"

  - `data.bounding_enddate_expense_items` (string)
    The latest date of all expense items (if any) in the project. The date may follow the project end date. 

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-07-01"

  - `data.bounding_startdate_time_entries` (string)
    The earliest date of all time entries (if any) in the project. The date may precede the project start date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-01-01"

  - `data.bounding_enddate_time_entries` (string)
    The latest date of all time entries (if any) in the project. The date may follow the project end date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-07-01"

  - `data.bounding_startdate_assignments` (string)
    The earliest start date a user is assigned to the project. The date may precede the project start date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-01-01"

  - `data.bounding_enddate_assignments` (string)
    The latest end date a user is assigned to the project. The date may follow the project end date.

Note: This property is only included if the fields query parameter includes bounding_dates or summary.
    Example: "2025-07-01"

  - `data.children` (object)
    The project phases, if any.

  - `data.confirmed_hours` (number)
    Example: 1283.600000000003

  - `data.confirmed_dollars` (number)
    Example: 160450

  - `data.approved_hours` (integer)

  - `data.approved_dollars` (number)

  - `data.unconfirmed_hours` (number)
    Example: 87.60000000000002

  - `data.unconfirmed_dollars` (number)
    Example: 10950

  - `data.scheduled_hours` (number)
    Example: 1322.400000000003

  - `data.scheduled_dollars` (number)
    Example: 165300

  - `data.future_hours` (integer)

  - `data.future_dollars` (number)