Sign in
project
public

Get Projects

Retrieve a list of projects.

Parameters:

  • proj_ids (list[str], optional): A list of project ids. If not provided, all projects will be retrieved.

Returns:

  • dict: A dict containing the status message and the list of project names.
get/v1/projects

Query parameters

proj_idsstring[]

A list of project ids

A list of project ids

search_termstring

Search term

Search term

limitinteger
offsetinteger
order_by'updated_at' | 'created_at' | 'id'

An enumeration.

order'asc' | 'desc'

An enumeration.

Headers

API-Versionstring

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Pass in an API version to guarantee a consistent response format.

The latest version should be used for all new API calls. Existing API calls should be updated to the latest version when possible.

Valid versions:

  • Latest API version (recommended): 2025-03

  • Previous API version (maintenance mode): 2025-02

If no API version header is included, the response format is considered unstable and could change without notice (not recommended).

Response

Successful Response

messagestring required

Changes