v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB

Projects

Listing Projects

The Projects listing endpoint is somewhat unique in that it is freely accessible to anybody, even unauthenticated clients. Rather than reject the user with a 403 or similar error, the Projects listing will only return Projects that the authenticated Actor is allowed to see. In most cases, this means that unauthenticated requests will receive [] in reply.

Currently, there are no paging or filtering options, so listing Projects will get you every Project you have access to.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to additionally retrieve the appUsers count of App Users and forms count of Forms within the Project, as well as the lastSubmission timestamp of the latest submission to any for in the project, if any.

get/v1/projects

Query parameters

formsboolean

(introduced: Version 1.5)

If set to true then endpoint also returns the Forms that the authenticated Actor is allowed to see, with those Forms nested within their corresponding Project under a new parameter formList. The returned Forms will match structure of Forms requested with extended metadata (including additional lastSubmission timestamp and submissions and reviewStates counts)

datasetsboolean

(introduced: Version 2023.4)

If set to true then endpoint also returns the Datasets that the authenticated Actor is allowed to see, with those Datasets nested within their corresponding Project under a new parameter datasetList. The returned Datasets will match structure of Datasets requested with extended metadata (including additional lastEntity timestamp and entities)

Response

idnumber

The numerical ID of the Project.

namestring required

The name of the Project.

descriptionstring

The description of the Project, which is rendered as Markdown on Frontend.

keyIdnumber

If managed encryption is enabled on the project, the numeric ID of the encryption key as tracked by Central is given here.

archivedboolean

Whether the Project is archived or not. null is equivalent to false. All this does is sort the Project to the bottom of the list and disable management features in the web management application.

Example response

[
  {
    "id": 1,
    "name": "Default Project",
    "description": "Description of this Project to show on Central.",
    "keyId": 3
  }
]