base44_docs

<div>
# API Reference

**Base URL:** <a href="https://full-stack-blueprint.base44.app/api" </a>

## Authentication

```
api_key: 4977cc7ef0ab4e93901261c177e4584e
Content-Type: application/json
```

## MasterTemplate

### Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Template name, e.g. 'Login + Signup + Profile' |
| `category` | string |  | e.g. Auth, Checkout, Dashboard |
| `status` | `draft`, `ready`, `deployed` |  |  |
| `tags` | array |  |  |
| `business_analysis` | object |  | problemStatement, users, coreFeatures, userStories, acceptanceCriteria, edgeCases, successMetrics |
| `frontend` | object |  | platforms, screens, uiState, apiIntegrationNotes, navigation |
| `backend` | object |  | architecture, endpoints, dataModels, auth, businessRules |
| `infrastructure` | object |  | environments, database, secrets, ciCd, loggingMonitoring |
| `tester` | object |  | testLevels, testPlan, testCases, qualityGates |
| `id` | string |  | Unique record identifier |
| `created_date` | string |  | Record creation timestamp |
| `updated_date` | string |  | Record last update timestamp |
| `created_by_id` | string |  | ID of the user who created the record |

### Endpoints

### `GET /entities/MasterTemplate`
List MasterTemplate records
Retrieve a list of MasterTemplate records with optional filtering, sorting, and pagination.

**Parameters:**
- `q` (query): JSON query filter, e.g. {"status":"active"}
- `limit` (query): Maximum number of records to return
- `skip` (query): Number of records to skip (pagination)
- `sort_by` (query): Field name to sort by. Prefix with '-' for descending order, e.g. -created_date

```bash
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `POST /entities/MasterTemplate`
Create a MasterTemplate record

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name"}'
```

### `DELETE /entities/MasterTemplate`
Delete multiple MasterTemplate records
**Warning:** Passing an empty `{}` query will delete ALL records in this entity.

```bash
# WARNING: passing an empty {} query will delete ALL records
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name"}'
```

### `POST /entities/MasterTemplate/bulk`
Bulk create MasterTemplate records

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/bulk" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '[{"name":"Example name"}]'
```

### `PUT /entities/MasterTemplate/bulk`
Bulk update MasterTemplate records
Each item must include an 'id' field along with the fields to update.

```bash
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/bulk" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '[{"id":"<record_id>","name":"Example name"}]'
```

### `PATCH /entities/MasterTemplate/update-many`
Update many MasterTemplate records by query
Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).

```bash
curl -X PATCH "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/update-many" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"query":{"name":"Example name"},"data":{"$set":{"name":"Example name"}}}'
```

### `GET /entities/MasterTemplate/{MasterTemplate_id}`
Get a MasterTemplate record by ID

**Parameters:**
- `MasterTemplate_id` (path): Record ID

```bash
# Replace <MasterTemplate_id> in the URL with an actual Record ID
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/<MasterTemplate_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/MasterTemplate/{MasterTemplate_id}`
Update a MasterTemplate record

**Parameters:**
- `MasterTemplate_id` (path): Record ID

```bash
# Replace <MasterTemplate_id> in the URL with an actual Record ID
# your data — fill in required fields
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/<MasterTemplate_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### `DELETE /entities/MasterTemplate/{MasterTemplate_id}`
Delete a MasterTemplate record
Soft-deletes the record. Use the restore endpoint to undo.

**Parameters:**
- `MasterTemplate_id` (path): Record ID

```bash
# Replace <MasterTemplate_id> in the URL with an actual Record ID
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/<MasterTemplate_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/MasterTemplate/{MasterTemplate_id}/restore`
Restore a deleted MasterTemplate record

**Parameters:**
- `MasterTemplate_id` (path): Record ID

```bash
# Replace <MasterTemplate_id> in the URL with an actual Record ID
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/MasterTemplate/<MasterTemplate_id>/restore" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

## Category

### Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Category name |
| `description` | string |  | Optional description of the category |
| `color` | string |  | Hex color used for the category swatch |
| `id` | string |  | Unique record identifier |
| `created_date` | string |  | Record creation timestamp |
| `updated_date` | string |  | Record last update timestamp |
| `created_by_id` | string |  | ID of the user who created the record |

### Endpoints

### `GET /entities/Category`
List Category records
Retrieve a list of Category records with optional filtering, sorting, and pagination.

**Parameters:**
- `q` (query): JSON query filter, e.g. {"status":"active"}
- `limit` (query): Maximum number of records to return
- `skip` (query): Number of records to skip (pagination)
- `sort_by` (query): Field name to sort by. Prefix with '-' for descending order, e.g. -created_date

```bash
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/Category" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `POST /entities/Category`
Create a Category record

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/Category" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name"}'
```

### `DELETE /entities/Category`
Delete multiple Category records
**Warning:** Passing an empty `{}` query will delete ALL records in this entity.

```bash
# WARNING: passing an empty {} query will delete ALL records
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/Category" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name"}'
```

### `POST /entities/Category/bulk`
Bulk create Category records

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/Category/bulk" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '[{"name":"Example name"}]'
```

### `PUT /entities/Category/bulk`
Bulk update Category records
Each item must include an 'id' field along with the fields to update.

```bash
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/Category/bulk" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '[{"id":"<record_id>","name":"Example name"}]'
```

### `PATCH /entities/Category/update-many`
Update many Category records by query
Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).

```bash
curl -X PATCH "https://full-stack-blueprint.base44.app/api/entities/Category/update-many" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"query":{"name":"Example name"},"data":{"$set":{"name":"Example name"}}}'
```

### `GET /entities/Category/{Category_id}`
Get a Category record by ID

**Parameters:**
- `Category_id` (path): Record ID

```bash
# Replace <Category_id> in the URL with an actual Record ID
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/Category/<Category_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/Category/{Category_id}`
Update a Category record

**Parameters:**
- `Category_id` (path): Record ID

```bash
# Replace <Category_id> in the URL with an actual Record ID
# your data — fill in required fields
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/Category/<Category_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### `DELETE /entities/Category/{Category_id}`
Delete a Category record
Soft-deletes the record. Use the restore endpoint to undo.

**Parameters:**
- `Category_id` (path): Record ID

```bash
# Replace <Category_id> in the URL with an actual Record ID
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/Category/<Category_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/Category/{Category_id}/restore`
Restore a deleted Category record

**Parameters:**
- `Category_id` (path): Record ID

```bash
# Replace <Category_id> in the URL with an actual Record ID
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/Category/<Category_id>/restore" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

## ActivityLog

### Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | `create`, `update`, `delete`, `bulk_update`, `bulk_delete` | Yes | The type of operation performed |
| `entity_id` | string |  | ID of the affected template, if applicable |
| `entity_name` | string |  | Name snapshot of the affected template |
| `summary` | string | Yes | Human-readable description of the activity |
| `id` | string |  | Unique record identifier |
| `created_date` | string |  | Record creation timestamp |
| `updated_date` | string |  | Record last update timestamp |
| `created_by_id` | string |  | ID of the user who created the record |

### Endpoints

### `GET /entities/ActivityLog`
List ActivityLog records
Retrieve a list of ActivityLog records with optional filtering, sorting, and pagination.

**Parameters:**
- `q` (query): JSON query filter, e.g. {"status":"active"}
- `limit` (query): Maximum number of records to return
- `skip` (query): Number of records to skip (pagination)
- `sort_by` (query): Field name to sort by. Prefix with '-' for descending order, e.g. -created_date

```bash
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/ActivityLog" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `POST /entities/ActivityLog`
Create a ActivityLog record

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/ActivityLog" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"action":"create","summary":"Example summary"}'
```

### `DELETE /entities/ActivityLog`
Delete multiple ActivityLog records
**Warning:** Passing an empty `{}` query will delete ALL records in this entity.

```bash
# WARNING: passing an empty {} query will delete ALL records
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/ActivityLog" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"action":"create"}'
```

### `POST /entities/ActivityLog/bulk`
Bulk create ActivityLog records

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/bulk" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '[{"action":"create","summary":"Example summary"}]'
```

### `PUT /entities/ActivityLog/bulk`
Bulk update ActivityLog records
Each item must include an 'id' field along with the fields to update.

```bash
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/bulk" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '[{"id":"<record_id>","action":"create","summary":"Example summary"}]'
```

### `PATCH /entities/ActivityLog/update-many`
Update many ActivityLog records by query
Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).

```bash
curl -X PATCH "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/update-many" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"query":{"action":"create"},"data":{"$set":{"action":"create"}}}'
```

### `GET /entities/ActivityLog/{ActivityLog_id}`
Get a ActivityLog record by ID

**Parameters:**
- `ActivityLog_id` (path): Record ID

```bash
# Replace <ActivityLog_id> in the URL with an actual Record ID
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/<ActivityLog_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/ActivityLog/{ActivityLog_id}`
Update a ActivityLog record

**Parameters:**
- `ActivityLog_id` (path): Record ID

```bash
# Replace <ActivityLog_id> in the URL with an actual Record ID
# your data — fill in required fields
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/<ActivityLog_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### `DELETE /entities/ActivityLog/{ActivityLog_id}`
Delete a ActivityLog record
Soft-deletes the record. Use the restore endpoint to undo.

**Parameters:**
- `ActivityLog_id` (path): Record ID

```bash
# Replace <ActivityLog_id> in the URL with an actual Record ID
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/<ActivityLog_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/ActivityLog/{ActivityLog_id}/restore`
Restore a deleted ActivityLog record

**Parameters:**
- `ActivityLog_id` (path): Record ID

```bash
# Replace <ActivityLog_id> in the URL with an actual Record ID
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/ActivityLog/<ActivityLog_id>/restore" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

## User

### Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string | Yes | The email of the user |
| `full_name` | string | Yes | The full name of the user |
| `role` | `admin`, `user` | Yes | The role of the user in the app |
| `id` | string |  | Unique record identifier |
| `created_date` | string |  | Record creation timestamp |
| `updated_date` | string |  | Record last update timestamp |
| `created_by_id` | string |  | ID of the user who created the record |

### Endpoints

### `GET /entities/User`
List User records
Retrieve a list of User records with optional filtering, sorting, and pagination.

**Parameters:**
- `q` (query): JSON query filter, e.g. {"status":"active"}
- `limit` (query): Maximum number of records to return
- `skip` (query): Number of records to skip (pagination)
- `sort_by` (query): Field name to sort by. Prefix with '-' for descending order, e.g. -created_date

```bash
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/User" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `POST /entities/User`
Create a User record

```bash
curl -X POST "https://full-stack-blueprint.base44.app/api/entities/User" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{"email":"Example email","full_name":"Example full_name","role":"admin"}'
```

### `GET /entities/User/{User_id}`
Get a User record by ID

**Parameters:**
- `User_id` (path): Record ID

```bash
# Replace <User_id> in the URL with an actual Record ID
curl -X GET "https://full-stack-blueprint.base44.app/api/entities/User/<User_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

### `PUT /entities/User/{User_id}`
Update a User record

**Parameters:**
- `User_id` (path): Record ID

```bash
# Replace <User_id> in the URL with an actual Record ID
# your data — fill in required fields
curl -X PUT "https://full-stack-blueprint.base44.app/api/entities/User/<User_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### `DELETE /entities/User/{User_id}`
Delete a User record
Soft-deletes the record. Use the restore endpoint to undo.

**Parameters:**
- `User_id` (path): Record ID

```bash
# Replace <User_id> in the URL with an actual Record ID
curl -X DELETE "https://full-stack-blueprint.base44.app/api/entities/User/<User_id>" \
  -H "api_key: 4977cc7ef0ab4e93901261c177e4584e" \
  -H "Content-Type: application/json"
```

</div>