Skip to main content
GET
/
projects
/
{project_reference}
/
environments
List Environments
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/environments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domains": [
        "<string>"
      ],
      "environment_variables": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "protected": true,
      "deployment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "<string>",
        "updated_at": "<string>",
        "release": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "export_status": "<string>",
          "build_status": "<string>",
          "deploy_status": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page_info": {
    "self": "<string>",
    "first": null,
    "next": "<string>",
    "prev": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

project_reference
string
required

Project ID or slug

Query Parameters

cursor
string

Cursor for pagination (environment ID)

limit
integer
default:20

Maximum number of environments to return (default: 20, max: 100)

Required range: 1 <= x <= 100

Response

Paginated list of environments for the project

data
object[]
required
page_info
object
required