Projects

Manage projects via the OnboardSync API

GET /api/projects

Projects

cURL

curl --request GET \
  --url https://api.example.com/api/projects \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "platforms": [
    {}
  ],
  "settings": {}
}
'

{
  "success": true,
  "data": [
    {
      "id": "proj_abc123xyz789",
      "name": "My Mobile App",
      "description": "Main iOS and Android app",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z",
      "settings": {
        "platforms": ["ios", "android"],
        "default_flow_id": "flow_def456"
      },
      "stats": {
        "total_flows": 3,
        "active_flows": 2,
        "total_users": 15420
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

List Projects

Get a list of all projects in your account.

page · number · default: "1"

Page number for pagination

limit · number · default: "20"

Number of items per page (max: 100)

sort · string · default: "-created_at"

Sort field and direction (prefix with - for descending)

{
  "success": true,
  "data": [
    {
      "id": "proj_abc123xyz789",
      "name": "My Mobile App",
      "description": "Main iOS and Android app",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z",
      "settings": {
        "platforms": ["ios", "android"],
        "default_flow_id": "flow_def456"
      },
      "stats": {
        "total_flows": 3,
        "active_flows": 2,
        "total_users": 15420
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

---

Get Project

Get details for a specific project.

id · string · required

The project ID

{
  "success": true,
  "data": {
    "id": "proj_abc123xyz789",
    "name": "My Mobile App",
    "description": "Main iOS and Android app",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "settings": {
      "platforms": ["ios", "android"],
      "default_flow_id": "flow_def456",
      "analytics_enabled": true,
      "custom_domain": null
    },
    "stats": {
      "total_flows": 3,
      "active_flows": 2,
      "total_users": 15420,
      "users_today": 342,
      "completion_rate": 0.76
    },
    "api_keys": {
      "project_id": "proj_abc123xyz789",
      "public_key": "pk_live_xyz789"
    }
  }
}

---

Create Project

Create a new project.

name · string · required

Project name (3-50 characters)

description · string

Project description (max 200 characters)

platforms · array

Target platforms: [“ios”], [“android”], or [“ios”, “android”]

{
  "success": true,
  "data": {
    "id": "proj_new123abc456",
    "name": "New Project",
    "description": "My new mobile app",
    "created_at": "2024-01-25T12:00:00Z",
    "updated_at": "2024-01-25T12:00:00Z",
    "settings": {
      "platforms": ["ios", "android"],
      "default_flow_id": null,
      "analytics_enabled": true
    },
    "api_keys": {
      "project_id": "proj_new123abc456",
      "public_key": "pk_live_new456"
    }
  }
}

---

Update Project

Update an existing project.

id · string · required

The project ID to update

name · string

Updated project name

description · string

Updated project description

settings · object

Updated settings object

{
  "success": true,
  "data": {
    "id": "proj_abc123xyz789",
    "name": "Updated Project Name",
    "description": "Updated description",
    "updated_at": "2024-01-25T15:30:00Z",
    "settings": {
      "platforms": ["ios", "android"],
      "default_flow_id": "flow_new789",
      "analytics_enabled": false
    }
  }
}

---

Delete Project

Delete a project and all associated data.

This action is irreversible. All flows, themes, and analytics data will be permanently deleted.

id · string · required

The project ID to delete

{
  "success": true,
  "message": "Project deleted successfully"
}

---

Project Statistics

Get detailed statistics for a project.

id · string · required

The project ID

period · string · default: "7d"

Time period: 1d, 7d, 30d, 90d

{
  "success": true,
  "data": {
    "overview": {
      "total_users": 15420,
      "new_users": 1234,
      "completion_rate": 0.76,
      "avg_completion_time": 45.2
    },
    "daily_stats": [
      {
        "date": "2024-01-25",
        "users": 342,
        "completions": 260,
        "completion_rate": 0.76
      }
    ],
    "flow_performance": [
      {
        "flow_id": "flow_abc123",
        "flow_name": "Default Onboarding",
        "users": 10234,
        "completion_rate": 0.78
      }
    ]
  }
}

---

Code Examples

Node.js

const axios = require('axios');

// List projects
const listProjects = async () => {
  const response = await axios.get('https://onboardsync.vercel.app/api/projects', {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  });
  return response.data;
};

// Create project
const createProject = async (projectData) => {
  const response = await axios.post(
    'https://onboardsync.vercel.app/api/projects',
    projectData,
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      }
    }
  );
  return response.data;
};