admin

List projects (admin)

Changed on

Paginated list of every project on the instance, regardless of ownership.

get/admin/projects

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/admin/projects
  • Auth
    API key in header Authorization

Query parameters

pageinteger

Page number, defaults to 1.

per_pageinteger

Items per page, defaults to the service setting.

sstring

Search projects by title, description or identifier.

Response

OK

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.

background_informationunknown
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.

Changes