v1
latestOpenAPI 3.0.32026-08-0613775357.6 KBprojects
List projects
Lists the accessible projects.
get/projects
Query parameters
fromstring date
Get projects that end on or after this date.
tostring date
Get projects that start on or before this date.
strictboolean
Set to true to restrict the projects to only those contained entirely within the from and to params.
fieldsstring
A comma-separated list (no spaces) of additional fields to include with each project in the response. Here are the optional values: "children", "tags", "budget_items", "project_state" , "phase_count", "summary", "custom_field_values"
filter_field'project_state'
Specifies the property to filter on. "project_state" is the only supported value.
filter_liststring
The value of "filter_field" to match, outputs will be projects with state matching this value. Possible values: Internal, Tentative, Confirmed
sort_field'created' | 'updated'
A project field on which to sort the projects in the response.
sort_order'ascending' | 'descending'
The order for sorting the results based on the sort_field.
project_codestring
Project code to match exactly.
phase_namestring
Phase name to match exactly.
with_archivedboolean
If set to true, includes archived projects.
with_phasesboolean
Set to `true`` to include phases (child projects).
archivedboolean
Set to `true`` to include archived projects.
per_pageinteger
The maximum number of items to show per response page.
Example:100
pageinteger
The response page to return.
Example:2
Response
The accessible projects.
Example response
{
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 821065,
"description": "Big pool in a small backyard.",
"guid": "d9d0de8f-32cc-4c0b-8af1-648ce039e3f6",
"name": "PR001: Example Project",
"project_code": "PR001",
"secureurl": "https://smartsheet.com/some/path",
"secureurl_expiration": "3000-01-01T00:00:00Z",
"ends_at": "2025-05-29",
"starts_at": "2025-01-27",
"created_at": "2025-01-22T06:00:30Z",
"updated_at": "2025-01-22T06:13:40Z",
"type": "Project",
"project_state_id": 8544040,
"thumbnail": "https://10kftprojectimages.s3.amazonaws.com/a62ffd30-316f-4cb6-9c7f-eca45d07a35d/499af1a7-bc6b-446f-8535-4472e6159246.png",
"owner_id": 11223344,
"client": "Your Client",
"tags": {
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 1234567,
"value": "New"
}
]
},
"custom_field_values": {
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 9996277,
"custom_field_name": "FY Goals",
"custom_field_id": 23654,
"value": "Effective Growth",
"created_at": "2025-04-11T23:37:21Z",
"updated_at": "2025-04-11T23:37:21Z"
}
]
},
"bounding_startdate": "2025-01-01",
"bounding_enddate": "2025-07-01",
"bounding_startdate_assignables": "2025-01-01",
"bounding_enddate_assignables": "2025-07-01",
"bounding_startdate_expense_items": "2025-01-01",
"bounding_enddate_expense_items": "2025-07-01",
"bounding_startdate_time_entries": "2025-01-01",
"bounding_enddate_time_entries": "2025-07-01",
"bounding_startdate_assignments": "2025-01-01",
"bounding_enddate_assignments": "2025-07-01",
"children": {
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 45678901,
"description": "Plan everything we must do to get this project done.",
"guid": "d9d0de8f-32cc-4c0b-8af1-648ce039e3f6",
"name": "PH001: Plan Phase",
"parent_id": 821065,
"project_code": "PH001",
"secureurl": "https://smartsheet.com/some/path",
"secureurl_expiration": "3000-01-01T00:00:00Z",
"ends_at": "2025-05-29",
"starts_at": "2025-01-27",
"created_at": "2025-01-22T06:00:30Z",
"updated_at": "2025-01-22T06:13:40Z",
"type": "Project",
"project_state_id": 8544040,
"thumbnail": "https://10kftprojectimages.s3.amazonaws.com/a62ffd30-316f-4cb6-9c7f-eca45d07a35d/499af1a7-bc6b-446f-8535-4472e6159246.png",
"owner_id": 11223344,
"owner_name": "Jane Doe",
"phase_name": "Plan",
"client": "Your Client",
"tags": {
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 1234567,
"value": "New"
}
]
},
"bounding_startdate": "2025-01-01",
"bounding_enddate": "2025-07-01",
"bounding_startdate_assignables": "2025-01-01",
"bounding_enddate_assignables": "2025-07-01",
"bounding_startdate_expense_items": "2025-01-01",
"bounding_enddate_expense_items": "2025-07-01",
"bounding_startdate_time_entries": "2025-01-01",
"bounding_enddate_time_entries": "2025-07-01",
"bounding_startdate_assignments": "2025-01-01",
"bounding_enddate_assignments": "2025-07-01",
"custom_field_values": {
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 9996277,
"custom_field_name": "FY Goals",
"custom_field_id": 23654,
"value": "Effective Growth",
"created_at": "2025-04-11T23:37:21Z",
"updated_at": "2025-04-11T23:37:21Z"
}
]
},
"confirmed_dollars": 160450,
"unconfirmed_hours": 87.60000000000002,
"unconfirmed_dollars": 10950,
"scheduled_hours": 1322.400000000003,
"scheduled_dollars": 165300
}
]
},
"confirmed_hours": 1283.600000000003,
"confirmed_dollars": 160450,
"unconfirmed_hours": 87.60000000000002,
"unconfirmed_dollars": 10950,
"scheduled_hours": 1322.400000000003,
"scheduled_dollars": 165300
}
]
}