App Data Management
Manage global application-level data like settings, feature flags, and shared configuration. Requires appId in SDK config.
App Data is global across your application. For per-user storage, use User Data APIs instead.
getAppData
GET /app/:appId/app-data OR /app/:appId/app-data/:category
| Param | Type | Required | Description |
|---|---|---|---|
| category | string | No | Optional filter by category |
Returns: AppDataItem[]
Typescript
1// Get all app data
2const allData = await authix.getAppData();
3
4// Get by category
5const settings = await authix.getAppData("settings");getSingleAppData
GET /app/:appId/data/:dataId
| Param | Type | Required | Description |
|---|---|---|---|
| dataId | string | Yes | Unique item ID |
Returns: AppDataItem
Typescript
1const item = await authix.getSingleAppData({
2 dataId: "setting_123",
3});searchInAppData
POST /app/:appId/app-data/search
| Param | Type | Required | Description |
|---|---|---|---|
| category | string | No | Filter by category |
| q | string | No | Search query |
| keys | object | No | Key-value filters |
Returns: AppDataItem[]
Typescript
1const results = await authix.searchInAppData({
2 category: "settings",
3 q: "dark",
4 keys: { theme: "dark" }
5});CRUD Operations
addAppData
POST /app/:appId/app-data/:dataCategory
| Param | Type | Required | Description |
|---|---|---|---|
| dataCategory | string | Yes | Category name |
| data | object | Yes | Stored as { item: data } |
Typescript
1const newItem = await authix.addAppData({
2 dataCategory: "settings",
3 data: { key: "theme", value: "dark" },
4});updateAppData
PATCH /app/:appId/data/:dataId
| Param | Type | Required | Description |
|---|---|---|---|
| dataId | string | Yes | Item ID |
| data | object | Yes | Fields to update |
Typescript
1await authix.updateAppData({
2 dataId: "setting_123",
3 data: { value: "light" },
4});deleteAppData
DELETE /app/:appId/data/:dataId
Typescript
1await authix.deleteAppData({
2 dataId: "setting_123",
3});Best Practices
- Use App Data only for global/shared configuration.
- Organize data using clear categories.
- Prefer searchInAppData instead of fetching all data.