listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.
Signature
Method signatures onclient.projects:
Parameters
listAll()
The argument object can be omitted.number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
listPage()
The argument object can be omitted.number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
Returns
listAll() result
AsyncGenerator<Project>
Yields one item at a time. The fields below describe each yielded item.
A project: a team-scoped container for pipelines and datasets.
ProjectId
required
Project ID with prefix
pp..string
required
Name of the project.
string
required
Identifier of the team that owns the project.
"draft" | "active"
required
Project state:
draft before activation or active after activation.string
required
Time the project was created, as an ISO 8601 timestamp.
listPage() result
Promise<{ projects: Project[]; pagination: Pagination }>
Project[]
required
Projects in this page.
Pagination
required
Pagination information for this page.
Errors
HTTP errors throwPotatoApiError. The endpoint documents these error responses:
HTTP endpoint:
GET /projects.