Skip to content
Overmind
Get started
API Reference
Projects

List projects

projects.list(ProjectListParams**kwargs) -> ProjectListResponse
GET/api/projects/

List projects

ParametersExpand Collapse
name: Optional[str]
ordering: Optional[str]

Which field to use when ordering the results.

page: Optional[int]

A page number within the paginated result set.

slug: Optional[str]
ReturnsExpand Collapse
class ProjectListResponse: …
count: int
results: List[Result]
id: str
formatuuid
created_at: datetime
formatdate-time
name: str
maxLength255
slug: str
maxLength255
updated_at: datetime
formatdate-time
description: Optional[str]
is_active: Optional[bool]
settings: Optional[object]
List projects
from overmind_lab import OvermindLab

client = OvermindLab()
projects = client.projects.list()
print(projects.count)
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "is_active": true,
      "settings": {}
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
Returns Examples
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "is_active": true,
      "settings": {}
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}