Skip to main content
GET
/
api
/
v1
/
projects
/
{id}
Get project by ID
curl --request GET \
  --url https://app.dimred.com/api/v1/projects/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "project_name": "<string>",
  "project_description": "<string>",
  "project_metadata": {},
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain from your DimRed dashboard. The organization context is automatically derived from the API key.

Path Parameters

​
id
string
required

Project identifier

Response

Project retrieved successfully

​
id
string

Unique identifier for the project

​
organization_id
string

Organization identifier

​
project_name
string

Name of the project

​
project_description
string | null

Description of the project

​
project_metadata
object

Additional metadata

​
created_at
string<date-time>

ISO 8601 timestamp of creation