Sign in

v51

latestSwagger 2.0AGPL-3.0-or-laterraw.githubusercontent.com2026-08-0116998415.7 KB
project

Get all projects a user has access to

Returns all projects a user has access to.

get/projects

Query parameters

pageinteger

The page number. Used for pagination. If not provided, the first page of results is returned.

per_pageinteger

The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

sstring

Search projects by title.

is_archivedboolean

If true, also returns all archived projects.

expandstring

If set to permissions, Vikunja will return the max permission the current user has on this project. You can currently only set this to permissions.

Response

The projects

background_blur_hashstring

Contains a very small version of the project background to use as a blurry preview until the actual background is loaded. Check out https://blurha.sh/ to learn how it works.

{"stackTrail":"components:schemas:models.Project:properties:background_information","oasType":"schema","type":"unknown","description":"Holds extra information about the background set since some background providers require attribution or similar. If not null, the background can be accessed at /projects/{projectID}/background"}
createdstring

A timestamp when this project was created. You cannot change this value.

descriptionstring

The description of the project.

hex_colorstring

The hex color of this project

idinteger

The unique, numeric id of this project.

identifierstring

The unique project short identifier. Used to build task identifiers.

is_archivedboolean

Whether a project is archived.

is_favoriteboolean

True if a project is a favorite. Favorite projects show up in a separate parent project. This value depends on the user making the call to the api.

max_permission0 | 1 | 2
parent_project_idinteger
positionnumber

The position this project has when querying all projects. See the tasks.position property on how to use this.

titlestring

The title of the project. You'll see this in the overview.

updatedstring

A timestamp when this project was last updated. You cannot change this value.