---
updatedAt: 2025-11-13T22:01:17.000Z
agentTools:
  projectIndex: https://coldstream.readme.io/llms.txt
---

# List projects

Retrieves a paginated list of projects for a given organization

`:param int organization_Id:` id of the organization for which you want to retrieve the projects list\
`:param string sortField_name: `optional parameter to sort the projects list on the project names\
`:param int sortField_order:` optional parameter to sort the projects list in a certain order.\
*The possible values are: '0 = ascending' -- '1 = descending'.*\
`:param int page_number:` optional parameter to only get the projects in the list on the given page number\
`:param int page_size:` optional parameter to select what size you want a page of the projects list to be\
`:param list[int] status: `optional parameter, used to filter what types of projects you want to see. If this parameter is given, then you will only see the projects that conform to 1 of the values in the status.\
The possible values are: *'0 = ongoing' -- '1 = problem' -- '2 = finished' -- '3 = closed'.*

<br />

API call function:

```python
def list_projects(self, organization_Id, sortField_name=None, sortField_order=None, page_number=None, page_size=None, status=[]) -> dict:

    url = self.project_url + "/organizations/" + str(organization_Id) + "/projects"

    #for the optional parameters
    url += "?"
    if sortField_name is not None:
        url += "SortField.Name=" + sortField_name + "&"
    if sortField_order is not None:
        url += "SortField.Order=" + str(sortField_order) + "&"
    if page_number is not None:
        url += "PageNumber=" + str(page_number) + "&"
    if page_size is not None:
        url += "PageSize=" + str(page_size) + "&"
    if not len(status) == 0:
        for st in status:
            url += "Status=" + str(st) + "&"
    
    url = url[:-1]

    response = requests.get(url, headers=self.get_header)

    if(response.ok): 
        print("projects list: \n", response.text, "\n")
        return response.json()
    else:
        logger.error(f"retrieving projects list failed: {response.content}")
        raise Exception
```

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Project API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://project.coldstream.diabatix.com"
    }
  ],
  "paths": {
    "/organizations/{organizationId}/projects": {
      "get": {
        "tags": [
          "Project"
        ],
        "summary": "List projects",
        "description": "Retrieves a paginated list of projects for a given organization",
        "parameters": [
          {
            "name": "organizationId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "Status",
            "in": "query",
            "schema": {
              "type": "array",
              "description": "Ongoing = 0\n Problem = 1\n Finished = 2\n Closed = 3",
              "items": {
                "$ref": "#/components/schemas/ProjectStatus"
              }
            }
          },
          {
            "name": "SortField.Name",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SortField.Order",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/SortOrder"
            }
          },
          {
            "name": "PageNumber",
            "in": "query",
            "schema": {
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "PageSize",
            "in": "query",
            "schema": {
              "maximum": 2147483647,
              "minimum": 1,
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectOverviewDtoPageResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectOverviewDtoPageResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProjectOverviewDtoPageResult"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CaseGroup": {
        "type": "object",
        "properties": {
          "caseStatus": {
            "$ref": "#/components/schemas/CaseStatus"
          },
          "caseCount": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "CaseStatus": {
        "enum": [
          0,
          1,
          2,
          3,
          4
        ],
        "description": "Created = 0\n Running = 1\n Finished = 2\n Stalled = 3\n Queued = 4",
        "type": "integer",
        "format": "int32",
        "minimum": 0,
        "maximum": 4
      },
      "ProjectAccessLevel": {
        "enum": [
          0,
          1,
          2
        ],
        "type": "integer",
        "format": "int32",
        "description": "Viewer = 0\n User = 1\n Owner = 2",
        "minimum": 0,
        "maximum": 2
      },
      "ProjectMemberDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "role": {
            "$ref": "#/components/schemas/Role"
          },
          "accessLevel": {
            "$ref": "#/components/schemas/ProjectAccessLevel"
          },
          "pictureUrl": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ProjectOverviewDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/ProjectStatus"
          },
          "caseGroups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CaseGroup"
            },
            "nullable": true
          },
          "members": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectMemberDto"
            },
            "nullable": true
          },
          "casesTotal": {
            "type": "integer",
            "format": "int32"
          },
          "membersTotal": {
            "type": "integer",
            "format": "int32"
          },
          "pictureUrl": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ProjectOverviewDtoPageResult": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProjectOverviewDto"
            },
            "nullable": true
          },
          "pageNumber": {
            "type": "integer",
            "format": "int64"
          },
          "pageSize": {
            "type": "integer",
            "format": "int64"
          },
          "totalItems": {
            "type": "integer",
            "format": "int64"
          },
          "totalPages": {
            "type": "integer",
            "format": "int64",
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "ProjectStatus": {
        "enum": [
          0,
          1,
          2,
          3
        ],
        "type": "integer",
        "format": "int32",
        "minimum": 0,
        "maximum": 3
      },
      "Role": {
        "enum": [
          0,
          1,
          2,
          3,
          4
        ],
        "type": "integer",
        "format": "int32",
        "description": "Viewer = 0\n User = 1\n SuperUser = 2\n Admin = 3\n SuperAdmin = 4",
        "minimum": 0,
        "maximum": 4
      },
      "SortOrder": {
        "enum": [
          0,
          1
        ],
        "type": "integer",
        "format": "int32",
        "description": "Asc = 0\n Desc = 1",
        "minimum": 0,
        "maximum": 1
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "description": "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\"",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```