Skip to main content
GET
https://api.us.vartiq.com
/
api
/
v1
/
projects
/
{projectId}
Get Project
curl --request GET \
  --url https://api.us.vartiq.com/api/v1/projects/{projectId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "company": "<string>",
    "environment": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

​
URL Parameters

​
projectId
string
required
The unique identifier of the project

​
Response

​
success
boolean
Indicates if the request was successful
​
message
string
A message describing the result of the operation
​
data
object
The project object

​
Response Example

{
  "success": true,
  "message": "Project retrieved successfully",
  "data": {
    "id": "proj_01JWB8YZNBQDJA3VZ3F8Z9C5NX",
    "name": "project stage24",
    "company": "6836eb8d404feca42c262a86",
    "environment": "development",
    "createdAt": "2025-05-28T11:03:12.308Z",
    "updatedAt": "2025-05-28T11:03:12.308Z"
  }
}