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

Get Project

View as MarkdownAgent setup

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.

GET
/projects/{projectId}

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

projectIdrequiredstring

ID of the project to fetch.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string"
{  "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"}

List Projects

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.

Update Project

Updates a project's settings. Only the fields present in `changes` are written, so this is a partial update despite the POST. Slugs are unique across Saasco. Reusing one that belongs to another project returns 409.