site-info

← All modules

6 endpoints.

GET /api/v1/instance-info

Instance Info

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Instance Info Api V1 Instance Info Get"
}

---

GET /api/v1/site-trial

Instance Trial State

This site's free-trial state — what the countdown banner and the first-login wizard render from (app.services.instance_trial).

AUTHENTICATED, unlike everything else in this module. The trial's end date is not a secret, but it is a commercial fact about a customer, and putting it on the public /instance-info payload would publish "this business is on trial until the 17th" to anyone who loaded their sign-in page. The two surfaces that consume it are both behind a session anyway.

Never raises: trial_state swallows a hub that is unreachable and returns "no trial", which renders nothing rather than erroring a page every user loads.

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Instance Trial State Api V1 Site Trial Get"
}

---

POST /api/v1/trial-start

Trial Start

Redeem the free-trial email's Sign in link: hand the sign-in page the issued username and password to fill in, and start the trial from this click (app.services.trial_signup.redeem_autofill).

PUBLIC — the person clicking has no session yet; the key in the link is the credential. Rate-limited per IP and per key.

Request body

{
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 128,
      "minLength": 16,
      "title": "Token"
    }
  },
  "type": "object",
  "required": [
    "token"
  ],
  "title": "_TrialStartIn"
}

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Trial Start Api V1 Trial Start Post"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

POST /api/v1/builder-login-code

Builder Login Code

A one-time sign-in link into THIS website-builder site for email, landing on the builder. Server-to-server only (the website secret), and only for an existing SUPERUSER of a website tenant on the websites instance — never creates an account, never elevates one.

Parameters

Name	In	Required	Type	Description
x-website-secret	header	no

Request body

{
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 255,
      "minLength": 3,
      "title": "Email"
    },
    "next": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "title": "Next"
    }
  },
  "type": "object",
  "required": [
    "email"
  ],
  "title": "_BuilderLoginIn"
}

200 — Successful Response

{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Builder Login Code Api V1 Builder Login Code Post"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

GET /api/v1/my-website

My Website

Whether the active org has a website of its own, and where.

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response My Website Api V1 My Website Get"
}

---

POST /api/v1/my-website/open

Open My Website

A one-time sign-in link into the active org's website, landing on next.

Request body

{
  "properties": {
    "next": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "title": "Next"
    }
  },
  "type": "object",
  "title": "_OpenWebsiteIn"
}

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Open My Website Api V1 My Website Open Post"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}