projects

Retrieve a single project in your workspace by its id.

Use this to fetch project details after creation, verify a project exists before performing operations, or resolve a project's metadata from its id.

Required Permissions

Your root key must have one of the following permissions:

  • project.*.read_project (to read any project)
  • project.<project_id>.read_project (to read a specific project)
post/v2/projects.getProject

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/projects.getProject
  • Auth
    HTTP bearer

Request body

projectstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "project": "proj_1234abcd"
}

Response

Successfully retrieved the project.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "proj_1234abcd",
    "name": "Payments Service",
    "slug": "payments-service",
    "createdAt": 1704067200000,
    "updatedAt": 1704153600000
  }
}

Changes

    • info

      the endpoint scheme security bearer was added to the API

    • info

      the endpoint scheme security rootKey was removed from the API

    • breaking

      added the new required request property

    • warning

      removed the request property