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

​
Headers

​
companyid
string
required
The unique identifier of your company

​
URL Parameters

​
appId
string
required
The unique identifier of the app

​
Response

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

​
Response Example

{
  "success": true,
  "message": "App retrieved successfully",
  "data": {
    "id": "app_01JT38AK6GH3VXP2PPH5BTF36X",
    "name": "second app",
    "description": "",
    "environment": "development",
    "createdAt": "2025-04-30T11:46:45.092Z",
    "updatedAt": "2025-04-30T11:46:45.092Z"
  }
}