Saasco logoSaasco logo
Saasco logoSaasco logo

Introduction

Quick StartWhat is Saasco?

Analytics

CRM

Email Marketing

Knowledge

Support

Projects

getList ProjectsgetGet ProjectpostUpdate ProjectdelDelete Project
Settings

List Projects

Lists the projects the caller can reach, each with its app configs. API keys are scoped to a single project, so an API-key caller always gets exactly that one project back. The paging and sorting parameters are only meaningful for session callers, who receive every project they are a member of.

GET
/projects

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

idstring

Return only the project with this ID.

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.

Default: 24

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.saasco.com/api/v2/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": {
      "completedSetupSteps": [
        "sdk"
      ],
      "contactListVisibleColumns": [
        {
          "id": "string",
          "order": 0
        }
      ],
      "defaultEmailCampaignSendOrder": {
        "direction": "asc",
        "propertyKey": "string"
      },
      "defaultEmailFromDomain": "string",
      "defaultEmailFromName": "string",
      "defaultEmailFromUsername": "string",
      "hasCompletedOnboarding": true,
      "knowledgeArticlesVisibleColumns": [
        {
          "id": "string",
          "order": 0
        }
      ],
      "timezone": "string",
      "useCases": [
        "onboarding"
      ]
    },
    "autoTopUpAmount": 20,
    "autoTopUpThreshold": 10,
    "appConfigs": [
      {
        "id": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "appId": "string",
        "activated": true,
        "setupCompleted": true,
        "projectId": "string"
      }
    ]
  }
]
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Get Inbound Email Attachment

Mints a short-lived download URL for one file on an inbound email. A POST rather than a GET because the URL expires and must not be cached. Returns 404 if the message or attachment does not belong to the project.

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.