Skip to main content
You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
Retrieve one project by its ID or slug. Use it to confirm a project exists or to look up its metadata before creating in it.

​
Usage

​
Flags

​
string
required
Project ID or slug. Both forms resolve to the same project.

​
Shared flags

Every unkey api command accepts these; CLI output and shared flags describes them in full.
​
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
​
string
Root key for the request. Falls back to UNKEY_ROOT_KEY, then to the config file written by unkey auth login. See CLI authentication.
​
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
​
string
default:"~/.unkey/config.toml"
Path of the TOML file that unkey auth login writes. Falls back to UNKEY_CONFIG.
​
string
Output format. Falls back to UNKEY_OUTPUT. Set json to print the full response envelope (meta and data) for piping; any other value prints the request ID followed by data.

​
Required permissions

Your root key needs one of:
  • project.*.read_project (any project)
  • project.<project_id>.read_project (a specific project)
If the project doesn’t exist or your key doesn’t have the permission, you get the same 404: The requested project does not exist. See Root key permissions for the full catalog.

​
Examples

Get a project by ID:
Get a project by slug and extract one field:

​
API endpoint

The command calls POST /v2/projects.getProject and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.
Last modified on September 29, 2026