Skip to main content
GET
/
projects
List Projects
curl --request GET \
  --url https://api.veryfront.com/projects \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "slug": "my-project",
      "name": "My Project",
      "description": "A sample project description",
      "is_claimed": true,
      "features": [
        "<string>"
      ],
      "environments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "protected": true,
          "domains": [
            "<string>"
          ],
          "environment_variables": [
            "<unknown>"
          ],
          "active_release_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "server_hostname": "<string>"
        }
      ],
      "releases": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "export_status": "<string>",
          "build_status": "<string>",
          "deploy_status": "<string>"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "published_at": "<string>",
      "prompt_count": 123,
      "config": {},
      "provider": "<string>",
      "layout": "<string>",
      "users": [
        {
          "id": "<string>",
          "email": "<string>",
          "name": "<string>",
          "role": "<string>",
          "avatar_src": "<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.

Query Parameters

cursor
string

Cursor for pagination from previous response

Example:

"eyJpZCI6IjEyMyJ9"

limit
number
default:20

Number of items per page (default: 20, max: 100)

Required range: 1 <= x <= 100
Example:

20

sort_by
string

Field to sort by (default: updated_at)

Example:

"created_at"

sort_order
enum<string>

Sort direction (default: desc)

Available options:
asc,
desc
Example:

"desc"

Search term to filter projects by name or slug

Example:

"my-project"

is_template
enum<string>

Filter by template status (true = only templates, false = exclude templates)

Available options:
true,
false
Example:

"false"

Response

Paginated list of projects

data
object[]
required
page_info
object
required