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": [
            null
          ],
          "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>",
      "system_managed": true,
      "users": [
        {
          "id": "<string>",
          "email": "<string>",
          "name": "<string>",
          "role": "<string>",
          "avatar_src": "<string>"
        }
      ],
      "capabilities": []
    }
  ],
  "page_info": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Query Parameters

​
cursor
string

Cursor for pagination from previous response

Example:

"eyJpZCI6IjEyMyJ9"

​
limit
number
default:20
Required range: 1 <= x <= 100
Example:

20

​
sort_by
string

Sort field.

Example:

"created_at"

​
sort_order
enum<string>

Sort order.

Available options:
asc,
desc
Example:

"desc"

​
search
string

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"

​
type
enum<string>

Filter by project type

Available options:
regular,
default,
template
Example:

"default"

​
system_managed
enum<string>

Filter by system managed status

Available options:
true,
false
Example:

"true"

​
access
enum<string>
default:all

Filter by relationship to the authenticated user: all accessible projects, owned projects, or invited projects

Available options:
all,
owned,
invited
Example:

"owned"

​
user_id
string<uuid>

Filter projects by a user ID that has access to them. Non-admin user tokens may only use their own user ID.

Example:

"660e8400-e29b-41d4-a716-446655440001"

Response

Paginated list of projects

​
data
object[]
required
​
page_info
object
required

Pagination cursor values for traversing the result set.