Projects

"Projects" serve as the primary container in our accelerator platform, encompassing organizations, objects, users, and more. Creation of projects is limited to root users, and each project includes dedicated data stores and scripts. Projects empower users to efficiently manage resources and develop customized backend services based on their unique requirements.

Project Data Model

Name	Data Type	Description
_id	String	System-generated unique identifier assigned to each project.
_createdAt	Date	Automatically generated timestamp indicating the date and time when the project was created.
_createdBy	String	System-generated identifier that signifies the user or entity responsible for creating the project.
_modifiedAt	Date	Automatically generated timestamp that denotes the date and time when a project was modified.
_modifiedBy	String	System-generated field that indicates the user who modified.
name	String	Represents the name of an project within the system.
slug	String	User-defined, URL-friendly identifier for the project.
templateId	String	Field in the project that allows users to select from a predefined templates or choose a blank template for setting up.
region	String	Store the timezone or geographical region associated with the project.
rootUserId	String	Store the information of the root user associated with the project.
objectConnectionStrings	String	Store the information to about the database where the objects related data can be stored.
authConnectionStrings	String	Store the information to about the database where the auth related data can be stored.

Example Project

[
  {
    "_id": "string",
    "_createdAt": "2023-06-01T03:12:27.764Z",
    "_createdBy": "string",
    "_modifiedAt": "2023-06-01T03:12:27.764Z",
    "_modifiedBy": "string",
    "name": "string",
    "slug": "string",
    "templateId": "string",
    "region": "string",
    "rootUserId": "string",
    "objectConnectionStrings": "string",
    "authConnectionStrings": "string"
  }
]

Create a Project

post

Sample request:

POST api/v1/SignUp
{        
  "name": "ProjectA",
  "slug": "project-a",
  "templateId": "123",
  "region": "us-east-1"
}

Authorizations

Body

application/jsontext/jsonapplication/*+json

namestringRequired

slugstringRequired

templateIdstringRequired

regionstringRequired

Responses

200

Success

text/plainapplication/jsontext/json

Responsestring

401

Unauthorized

403

Forbidden

post

HTTPcURLJavaScriptPython

POST /api/v1/CreateProject HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "name": "text",
  "slug": "text",
  "templateId": "text",
  "region": "text"
}

application/jsontext/jsonapplication/*+json

text

Get all Projects

get

Sample request:

GET api/v1/GetProjects

Authorizations

Responses

200

Success

text/plainapplication/jsontext/json

401

Unauthorized

403

Forbidden

get

HTTPcURLJavaScriptPython

GET /api/v1/GetProjects HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "createdAt": "2025-07-31T16:43:44.143Z",
    "createdBy": "text",
    "modifiedAt": "2025-07-31T16:43:44.143Z",
    "modifiedBy": "text",
    "name": "text",
    "slug": "text",
    "templateId": "text",
    "region": "text",
    "rootUserId": "text",
    "objectConnectionStrings": "text",
    "authConnectionStrings": "text"
  }
]