Projects

Getting Project Details

Changed on

To get just the details of a single Project, GET its single resource route by its numeric ID.

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.

In addition, the extended metadata version of this endpoint (but not the overall Project listing) returns an array of the verbs the authenticated Actor is able to perform on/within the Project.

get/v1/projects/{id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{id}
  • Auth
    none declared

Path parameters

idnumber required

The numeric ID of the Project

Query parameters

verbsboolean

If set to true, will return allowed verbs for the current actor on this project. When extended metadata is requested, this parameter is ignored, and verbs are always included.

Response

This is the Extended Metadata response, if requested via the appropriate header:

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
}

Changes