Projects

List, create, get, update Forvibe projects.

Updated 2026-05-24
3 min read

Projects are the top-level container for everything in Forvibe — your landing page, store listings, ASO data, screenshots, reviews. Every project belongs to an organization; API keys are bound to one org and only see projects in that org.

List projects

bash
GET /api/v1/projects?limit=25&search=mygame

# Required scope: projects:read

Get a single project

bash
GET /api/v1/projects/:projectId

# Required scope: projects:read

Create a project

bash
POST /api/v1/projects
Content-Type: application/json

{
  "name": "My Game",
  "description": "Indie puzzle game",
  "subdomain": "my-game",
  "mail_prefix": "support"
}

# Required scope: projects:write
# Returns: 201 + Location: /api/v1/projects/:id

Update a project

bash
PATCH /api/v1/projects/:projectId
Content-Type: application/json

{
  "description": "Updated description",
  "subdomain": "my-renamed-game"
}

# Required scope: projects:write
# Returns: { data: Project, updated_fields: ["description", "subdomain"] }

Check availability

Test a subdomain or mail prefix before you create or rename:

bash
POST /api/v1/projects/availability-check
Content-Type: application/json

{
  "field": "subdomain",
  "value": "my-game",
  "exclude_project_id": "..." // optional, when renaming
}

# Returns: { "available": true, "field": "subdomain", "value": "my-game" }

Validation rules

  • name — 1 to 120 characters.
  • subdomain — 3 to 40 chars, [a-z0-9-], unique across Forvibe.
  • mail_prefix — 1 to 40 chars, [a-z0-9.-], unique.
  • description — up to 2000 chars.