GET /projectsList the projects.
Servers
[
{
"url": "https://api.veryfront.com"
}
]Authentication
[
{
"bearerAuth": []
},
{
"apiKeyAuth": []
}
]{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or API Key",
"description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
},
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
}
}Parameters
Parameter contracts
[
{
"schema": {
"type": "string",
"description": "Use page_info.next from the previous response. A null next cursor means the final page.",
"example": "eyJpZCI6IjEyMyJ9"
},
"required": false,
"name": "cursor",
"in": "query"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20,
"description": "Integer page size from 1 to 100. Defaults to 20.",
"example": 20
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Sort by updated_at, created_at, name, or slug. Defaults to updated_at; unknown fields also use updated_at.",
"example": "created_at"
},
"required": false,
"name": "sort_by",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Ascending or descending order. Defaults to desc.",
"example": "desc"
},
"required": false,
"name": "sort_order",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Search term to filter projects by name or slug",
"example": "my-project"
},
"required": false,
"name": "search",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Filter by template status (true = only templates, false = exclude templates)",
"example": "false"
},
"required": false,
"name": "is_template",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"regular",
"default",
"template"
],
"description": "Filter by project type",
"example": "default"
},
"required": false,
"name": "type",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Filter by system managed status",
"example": "true"
},
"required": false,
"name": "system_managed",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"all",
"owned",
"invited",
"shared"
],
"default": "all",
"description": "Filter by relationship to the authenticated user: all accessible projects, owned projects, or invited projects",
"example": "owned"
},
"required": false,
"name": "access",
"in": "query"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "Only accessible projects in this account."
},
"required": false,
"name": "account_id",
"in": "query"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "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"
},
"required": false,
"name": "user_id",
"in": "query"
},
{
"schema": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Label filters as key or key=value, repeated or comma-separated. All filters must match. Example: ?label=team=platform&label=criticality=high"
},
"required": false,
"name": "label",
"in": "query"
}
]Responses
200
Paginated list of projects
{
"description": "Paginated list of projects",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
},
"page_info": {
"$ref": "#/components/schemas/PageInfo"
}
},
"required": [
"data",
"page_info"
]
}
}
}
}400
Invalid query or label filter
{
"description": "Invalid query or label filter",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}401
Authentication required
{
"description": "Authentication required",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}403
Access denied to the requested project scope or user filter
{
"description": "Access denied to the requested project scope or user filter",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}500
Server error
{
"description": "Server error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}Referenced contracts
components/schemas/Project
{
"type": "object",
"properties": {
"account_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"account_name": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string",
"format": "uuid",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"slug": {
"type": "string",
"example": "my-project"
},
"name": {
"type": "string",
"example": "My Project"
},
"description": {
"type": "string",
"example": "A sample project description"
},
"is_claimed": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"environments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"protected": {
"type": "boolean"
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"environment_variables": {
"type": "array",
"items": {}
},
"active_release_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"server_hostname": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name"
]
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"export_status": {
"type": "string"
},
"build_status": {
"type": "string"
},
"deploy_status": {
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"created_at": {
"type": "string",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"example": "2024-01-15T10:30:00Z"
},
"published_at": {
"type": "string"
},
"prompt_count": {
"type": "number"
},
"config": {
"$ref": "#/components/schemas/ProjectConfig"
},
"provider": {
"type": [
"string",
"null"
]
},
"layout": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"regular",
"default",
"template"
]
},
"system_managed": {
"type": "boolean"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"avatar_src": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project.read",
"project.settings.manage",
"project.delete",
"project.members.read",
"project.members.manage",
"project.invites.read",
"project.invites.manage",
"project.files.read",
"project.files.write",
"project.realtime.connect",
"project.realtime.write",
"project.files.admin",
"project.uploads.read",
"project.uploads.write",
"project.uploads.admin",
"project.knowledge.read",
"project.knowledge.write",
"project.releases.read",
"project.releases.write",
"project.deployments.read",
"project.deployments.write",
"project.deploy.execute",
"project.runtime.manage",
"project.channels.read",
"project.channels.write",
"project.sandboxes.manage",
"project.domains.write",
"project.environments.manage",
"project.env_vars.write",
"project.runs.read",
"project.runs.write",
"project.runs.admin",
"project.agents.read",
"project.agents.write",
"project.evals.read",
"project.evals.write",
"project.evals.run",
"project.conversations.read",
"project.conversations.write",
"project.conversations.create",
"project.integrations.read",
"project.integrations.connect",
"project.integrations.configure",
"project.api_keys.read",
"project.api_keys.manage",
"project.cache.read",
"project.cache.write",
"project.logs.read",
"project.metrics.read",
"project.resources.read"
]
}
},
"capabilities_version": {
"type": "integer"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"namespace": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": [
"string",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"namespace",
"key",
"value"
]
}
}
},
"required": [
"id",
"slug",
"name"
]
}components/schemas/ProjectConfig
{
"type": "object",
"properties": {
"disable_meta_robots": {
"type": "boolean",
"description": "When true, the rendered site asks crawlers not to index it (noindex robots meta tag)."
},
"provider_id": {
"type": [
"string",
"null"
],
"description": "Identifier of the provider backing the project, or null when none is configured. Not necessarily a UUID."
},
"layout_id": {
"type": [
"string",
"null"
],
"description": "Identifier of the layout applied to the project, or null when none is configured."
},
"is_template": {
"type": "boolean",
"description": "Whether the project is offered in the template gallery."
},
"coming_soon": {
"type": "boolean",
"description": "Whether the template is listed as coming soon in the gallery."
},
"category": {
"type": [
"string",
"null"
],
"description": "Template gallery category, or null when uncategorised."
},
"description": {
"type": [
"string",
"null"
],
"description": "Template gallery description, or null when none is set."
},
"disableMetaRobots": {
"type": "boolean",
"description": "Legacy camelCase spelling of `disable_meta_robots`; carries the same value. Prefer `disable_meta_robots`."
},
"providerId": {
"type": [
"string",
"null"
],
"description": "Legacy camelCase spelling of `provider_id`; carries the same value. Prefer `provider_id`."
},
"layoutId": {
"type": [
"string",
"null"
],
"description": "Legacy camelCase spelling of `layout_id`; carries the same value. Prefer `layout_id`."
},
"isTemplate": {
"type": "boolean",
"description": "Legacy camelCase spelling of `is_template`; carries the same value. Prefer `is_template`."
},
"comingSoon": {
"type": "boolean",
"description": "Legacy camelCase spelling of `coming_soon`; carries the same value. Prefer `coming_soon`."
}
},
"additionalProperties": false,
"description": "Project configuration. Field names use snake_case. Legacy camelCase aliases contain the same values."
}components/schemas/PageInfo
{
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor pointing to the current page"
},
"first": {
"type": "null",
"description": "First page cursor (always null for cursor-based pagination)"
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page (null if no more pages)"
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page (null if on first page)"
}
},
"required": [
"self",
"first",
"next",
"prev"
]
}components/schemas/Problem
{
"type": "object",
"properties": {
"cause": {
"type": "string",
"enum": [
"schedule_concurrency_forbidden",
"schedule_fire_in_progress",
"schedule_run_limit_reached"
],
"description": "Schedule admission refusal."
},
"idempotency": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"in_progress",
"payload_mismatch",
"outcome_unknown"
]
},
"operation": {
"type": "string",
"minLength": 1
},
"retryable": {
"type": "boolean"
},
"retry_after_seconds": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expires_at": {
"type": [
"string",
"null"
]
},
"recovery": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"resource_url": {
"type": "string"
}
},
"required": [
"available",
"description"
]
}
},
"required": [
"state",
"operation",
"retryable",
"retry_after_seconds",
"expires_at"
],
"description": "Replay status, retry timing, and recovery lookup."
},
"type": {
"type": "string",
"description": "URI reference identifying the problem type",
"example": "https://api.veryfront.com/errors/validation-failed"
},
"title": {
"type": "string",
"description": "Short human-readable summary of the problem",
"example": "Validation Failed"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599,
"description": "HTTP status code",
"example": 400
},
"code": {
"type": "string",
"description": "Stable machine-readable error code",
"example": "RUN_INVALID_INPUT"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence",
"example": "The 'email' field must be a valid email address"
},
"instance": {
"type": "string",
"description": "URI reference identifying the specific occurrence",
"example": "/projects/my-project/members"
},
"slug": {
"type": "string",
"description": "Stable identifier for the problem type",
"example": "validation-failed"
},
"category": {
"type": "string",
"enum": [
"AUTH",
"RESOURCE",
"VALIDATION",
"DATABASE",
"SUBSCRIPTION",
"INTEGRATION",
"INTERNAL"
],
"description": "API error category",
"example": "VALIDATION"
},
"suggestion": {
"type": "string",
"description": "Suggested action to resolve the problem",
"example": "Check the request body and query parameters against the API documentation."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field path that caused the error",
"example": "email"
},
"message": {
"type": "string",
"description": "Error message for this field",
"example": "Invalid email format"
},
"code": {
"type": "string",
"description": "Error code for this field",
"example": "INVALID_FORMAT"
}
},
"required": [
"field",
"message"
]
},
"description": "Detailed field-level errors for validation failures"
}
},
"required": [
"type",
"title",
"status"
]
}Operation contract
{
"operationId": "listProjects",
"tags": [
"projects/Projects/Projects"
],
"summary": "List projects",
"description": "List the projects.",
"parameters": [
{
"schema": {
"type": "string",
"description": "Use page_info.next from the previous response. A null next cursor means the final page.",
"example": "eyJpZCI6IjEyMyJ9"
},
"required": false,
"name": "cursor",
"in": "query"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20,
"description": "Integer page size from 1 to 100. Defaults to 20.",
"example": 20
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Sort by updated_at, created_at, name, or slug. Defaults to updated_at; unknown fields also use updated_at.",
"example": "created_at"
},
"required": false,
"name": "sort_by",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Ascending or descending order. Defaults to desc.",
"example": "desc"
},
"required": false,
"name": "sort_order",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Search term to filter projects by name or slug",
"example": "my-project"
},
"required": false,
"name": "search",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Filter by template status (true = only templates, false = exclude templates)",
"example": "false"
},
"required": false,
"name": "is_template",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"regular",
"default",
"template"
],
"description": "Filter by project type",
"example": "default"
},
"required": false,
"name": "type",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Filter by system managed status",
"example": "true"
},
"required": false,
"name": "system_managed",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"all",
"owned",
"invited",
"shared"
],
"default": "all",
"description": "Filter by relationship to the authenticated user: all accessible projects, owned projects, or invited projects",
"example": "owned"
},
"required": false,
"name": "access",
"in": "query"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "Only accessible projects in this account."
},
"required": false,
"name": "account_id",
"in": "query"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "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"
},
"required": false,
"name": "user_id",
"in": "query"
},
{
"schema": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Label filters as key or key=value, repeated or comma-separated. All filters must match. Example: ?label=team=platform&label=criticality=high"
},
"required": false,
"name": "label",
"in": "query"
}
],
"responses": {
"200": {
"description": "Paginated list of projects",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
},
"page_info": {
"$ref": "#/components/schemas/PageInfo"
}
},
"required": [
"data",
"page_info"
]
}
}
}
},
"400": {
"description": "Invalid query or label filter",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "Authentication required",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"403": {
"description": "Access denied to the requested project scope or user filter",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-documentation-source-tag": "Projects",
"x-canonical-documentation": {
"domain": "projects",
"resource": "Projects",
"subgroup": "Projects",
"name": "List projects",
"description": "List the projects.",
"operationId": "listProjects"
},
"x-mint": {
"href": "/cloud/rest/api-reference/projects-projects-projects/list-projects"
}
}