v1

latestOpenAPI 3.0.02026-07-1717466209.0 KB

Projects

Get project JSON

Get project metadata as JSON. For microdata/survey projects, the response includes all variables by default. Use exclude_variables=1 to omit variables from the response (useful when only study-level metadata is needed, e.g. for comparison workflows).

get/editor/json{id}

Path parameters

idstring required

Project ID or IDNO

Query parameters

versionstring

Get metadata for a specific version number (e.g. 1.0.0)

exclude_variables0 | 1

Exclude variables from the response. Only applicable to microdata/survey projects. When set to 1, the variables array is omitted from the JSON output. The data_files array is still included.

exclude_private_fields0 | 1

Exclude fields marked as private in the project template. Set to 1 to omit private fields from the response.

external_resources0 | 1

Include external resources (documentation files) in the response. Set to 1 to append the external_resources array to the JSON output.

admin_metadata0 | 1

Include administrative metadata in the response. Set to 1 to append the admin_metadata object to the JSON output.

Response

successful operation