---
title: "Business modules of a project: counts, embed script, payments state"
method: GET
path: "/projects/{projectId}/business"
tags: ["Business"]
---

# Business modules of a project: counts, embed script, payments state

`GET /projects/{projectId}/business`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/projects/{projectId}/business`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `projectId` string, uuid, required

## Response `200`

Overview

- object
  - `projectId` string, uuid, required
  - `apiBase` string, required
  - `embedScriptUrl` string, required
  - `forms` object, required
    - `count` integer, required
    - `unread` integer, required
  - `newsletter` object, required
    - `lists` integer, required
    - `subscribers` integer, required
  - `bookings` object, required
    - `services` integer, required
    - `upcoming` integer, required
  - `payments` object, required
    - `available` boolean, required
    - `reason` 'not_configured' | 'switched_off' | 'null', nullable, required
    - `connected` boolean, required
    - `account` object, nullable, required
      - `id` string, required
      - `name` string, nullable, required
      - `livemode` boolean, required
      - `connectedAt` string, required: ISO-8601 timestamp
  - `sendingDomains` string[], required
  - `platformEmail` boolean, required
  - `heldBackEmails` integer, required

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `402`: A module limit was reached (code limit_reached)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Not possible in the current state (code conflict)
- `429`: Too many requests (code rate_limited)
- `501`: Not available on this server (code not_configured)
- `503`: Stripe or the mail service did not answer (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)