GET
/
apps
curl --request GET \
  --url https://api.us.vartiq.com/apps \
  --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

​
Query Parameters

​
projectId
string
required

Filter apps by project ID

​
environment
string

Filter apps by environment (“development” or “production”)

​
limit
number
default:"10"

Maximum number of apps to return

​
skip
number
default:"0"

Number of apps to skip for pagination

​
Response

​
success
boolean

Indicates if the request was successful

​
message
string

A message describing the result of the operation

​
data
array

Array of app objects

​
Response Example

{
  "success": true,
  "message": "Apps 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"
    },
    {
      "id": "app_01JSZ1B53E22QS6TA3441ZTSFS",
      "name": "Production App",
      "description": "Production app",
      "environment": "production",
      "createdAt": "2025-04-28T20:27:45.648Z",
      "updatedAt": "2025-04-28T20:27:45.648Z"
    }
  ]
}
GET
/
apps
curl --request GET \
  --url https://api.us.vartiq.com/apps \
  --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

​
Query Parameters

​
projectId
string
required

Filter apps by project ID

​
environment
string

Filter apps by environment (“development” or “production”)

​
limit
number
default:"10"

Maximum number of apps to return

​
skip
number
default:"0"

Number of apps to skip for pagination

​
Response

​
success
boolean

Indicates if the request was successful

​
message
string

A message describing the result of the operation

​
data
array

Array of app objects

​
Response Example

{
  "success": true,
  "message": "Apps 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"
    },
    {
      "id": "app_01JSZ1B53E22QS6TA3441ZTSFS",
      "name": "Production App",
      "description": "Production app",
      "environment": "production",
      "createdAt": "2025-04-28T20:27:45.648Z",
      "updatedAt": "2025-04-28T20:27:45.648Z"
    }
  ]
}