Get Projects
curl --request GET \
--url https://api.us.vartiq.com/api/v1/projects \
--header 'companyid: <companyid>' \
--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>"
}
]
}Headers
The unique identifier of your organization
Response
Indicates if the request was successful
A message describing the result of the operation
Array of project objects
Show Properties
Show Properties
Unique identifier for the project
Name of the project
Description of the project (if provided)
Company ID associated with the project
Environment of the project (e.g., “development”)
Timestamp when the project was created
Timestamp when the project was last updated
Response Example
{
"success": true,
"message": "Projects 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"
}
]
}
curl --request GET \
--url https://api.us.vartiq.com/api/v1/projects \
--header 'companyid: <companyid>' \
--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>"
}
]
}Get Started
API Reference
- Projects
- Apps
- Webhooks
- Webhook Messages
Get Projects
curl --request GET \
--url https://api.us.vartiq.com/api/v1/projects \
--header 'companyid: <companyid>' \
--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>"
}
]
}Headers
The unique identifier of your organization
Response
Indicates if the request was successful
A message describing the result of the operation
Array of project objects
Show Properties
Show Properties
Unique identifier for the project
Name of the project
Description of the project (if provided)
Company ID associated with the project
Environment of the project (e.g., “development”)
Timestamp when the project was created
Timestamp when the project was last updated
Response Example
{
"success": true,
"message": "Projects 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"
}
]
}
curl --request GET \
--url https://api.us.vartiq.com/api/v1/projects \
--header 'companyid: <companyid>' \
--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>"
}
]
}