Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

OverviewGetting startedAgent setupWhat is Saasco?

SDK

Quick startTrackingIdentifyConfigurationWidgetsProperties

MCP

Quick startHow it worksAuthorizationTool reference
Skills for agents

REST API

Quick start
getList ProjectsgetGet ProjectpostUpdate ProjectdelDelete Project
ProjectsSettings

List Projects

View as MarkdownAgent setup

Lists the projects the caller can reach, each with its app configs. Pass id to return only that project; an unknown or inaccessible id returns 404. Omit id for every reachable project. take pages that list, and includeId keeps one project on the page without filtering. API keys are scoped to a single project. An MCP URL with ?projectId= is limited to that project. The MCP tool returns a short summary; this REST response is the full record.

GET
/projects

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

idstring

Return only the project with this ID. An unknown or inaccessible ID is an error.

includeIdstring

When take is set, keep this project on the page if the caller can reach it. Does not filter the list. Ignored when id is set.

orderBystring

Field to sort by. Omit to keep the default ordering.

Value in: "name" | "description" | "createdAt"
orderDirectionstring

Sort direction. Defaults to desc. Ignored unless orderBy is set.

Value in: "asc" | "desc"
skipnumber

Number of projects to skip before collecting results.

Default: 0
takenumber

Maximum number of projects to return. Omit to return every project.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects"
[  {    "id": "string",    "createdAt": "string",    "updatedAt": "string",    "name": "string",    "tagline": "string",    "slug": "string",    "balance": 0,    "balanceVersion": -9007199254740991,    "thumbnail": "string",    "stripeCustomerId": "string",    "testStripeCustomerId": "string",    "autoTopUpEnabled": true,    "meta": {      "agentSetupStartedAt": "string",      "sdkInstalledAt": "string",      "onboardingCompletedAt": "string",      "onboardingStep": "name",      "onboardingManual": true,      "contactListVisibleColumns": [        {          "id": "string",          "order": 0        }      ],      "defaultEmailCampaignSendOrder": {        "direction": "asc",        "propertyKey": "string"      },      "defaultEmailFromDomain": "string",      "defaultEmailFromName": "string",      "defaultEmailFromUsername": "string",      "companyAddressLine1": "string",      "companyAddressLine2": "string",      "companyCity": "string",      "companyRegion": "string",      "companyPostalCode": "string",      "companyCountry": "st",      "knowledgeArticlesVisibleColumns": [        {          "id": "string",          "order": 0        }      ],      "timezone": "string",      "setupGuideVisits": [        "string"      ],      "setupGuideSkips": [        "string"      ],      "setupGuideTestEmailSent": true,      "setupGuideGoLiveConfirmed": true    },    "liveProjectId": "string",    "autoTopUpAmount": 20,    "autoTopUpThreshold": 10,    "appConfigs": [      {        "id": "string",        "createdAt": "string",        "updatedAt": "string",        "appId": "string",        "activated": true,        "setupCompleted": true,        "projectId": "string"      }    ],    "helpCenterId": "string"  }]

Set Benchmark Preferences

Stores the cohort and funnel-step mapping used to compare this project's metrics with benchmarks. Replaces the previous preferences. Point each step at an event this product already tracks. Skip a step you cannot match. Do not invent events.

Get Project

Fetches a single project along with its app configs: one entry per Saasco app the project has enabled, carrying that app's activation and setup-completion state. Returns 404 if the project does not exist.