Documentation Index Fetch the complete documentation index at: https://mintlify.com/nayalsaurav/deploy-your-app/llms.txt
Use this file to discover all available pages before exploring further.
The List Projects endpoint returns all projects owned by the currently authenticated user. Each project record includes its repository reference, build configuration, deployment URL, and custom domain status. Use this endpoint to build dashboards, populate project selectors, or audit your deployment inventory.
GET /api/v1/projectsAuthentication This endpoint requires an active session. Include your session cookie with every request. See Authentication for details on obtaining a session token. Request This endpoint takes no query parameters or request body.
Response A successful 200 OK response returns a JSON object with the following shape:
{ "message" : "Projects fetched successfully" , "data" : { "projects" : [ Project ] } }
Project Object Human-readable status message — "Projects fetched successfully".
Wrapper object containing the result payload. Array of project objects belonging to the authenticated user. Empty array if none exist. Unique project identifier (cuid format), e.g. "clx4z2k0e0000abc123def456".
ID of the user who owns this project.
Human-readable display name for the project.
Full GitHub repository path in owner/repo format, e.g. "acme/my-app".
Branch used for production deployments. Defaults to "main".
Custom build command override, e.g. "npm run build". null if auto-detected.
Custom start/run command override, e.g. "node server.js". null if auto-detected.
Path to the application root within the repository, e.g. "apps/web". null if the repo root is used.
The auto-generated deployment URL assigned after the first successful build. null until a deployment succeeds.
A custom hostname attached to this project, e.g. "app.example.com". null if none is configured.
Whether the custom domain’s DNS records have been verified. Always false immediately after a domain is set.
ISO 8601 timestamp of when the project was created.
ISO 8601 timestamp of the most recent project update.
Example curl -X GET https://your-domain.com/api/v1/projects \ -H 'Content-Type: application/json' \ -b 'better-auth.session_token=YOUR_SESSION_TOKEN'
Example response: { "message" : "Projects fetched successfully" , "data" : { "projects" : [ { "id" : "clx4z2k0e0000abc123def456" , "userId" : "user_01hxyz" , "name" : "My Next.js App" , "repositoryFullName" : "acme/my-nextjs-app" , "defaultBranch" : "main" , "buildCommand" : null , "startCommand" : null , "rootDirectory" : null , "deploymentUrl" : "https://my-nextjs-app.your-domain.com" , "customDomain" : "app.example.com" , "customDomainVerified" : true , "createdAt" : "2024-06-01T12:00:00.000Z" , "updatedAt" : "2024-06-10T09:30:00.000Z" } ] } }
Error Responses Status Error Message Description 401"Unauthorized"No valid session cookie was provided. 500"failed to fetch projects"An unexpected server-side error occurred.