at.happyproto.actor.getAccount Documentation (EN)

main query

Whether the caller is a HappyProto customer, and how many instances they have of how many allowed. Any signed-in caller; a non-customer gets zeros.

Output

Encodingapplication/json

instanceCount integer Required

Instances counting against the limit. 0 for a non-customer.

instanceLimit integer Required

The most instances the caller may have. 0 for a non-customer.

isCustomer boolean Required

Whether the caller may use the customer endpoints.

Errors

AuthRequired This endpoint requires an authenticated caller.

Forbidden Passed through from the provisioner.

InvalidRequest The provisioner refused the request as malformed. Not expected from this read; declared because every provisioner refusal is mapped the same way.

NotFound Passed through from the provisioner.

InvalidSlug Passed through from the provisioner.

SlugTaken Passed through from the provisioner.

NotEntitled Passed through from the provisioner.

InstanceLimit Passed through from the provisioner.

NoCapacity Passed through from the provisioner.

OperationInProgress Passed through from the provisioner.

Upstream The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "description": "Whether the caller is a HappyProto customer, and how many instances they have of how many allowed. Any signed-in caller; a non-customer gets zeros.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "Forbidden"
    },
    {
      "description": "The provisioner refused the request as malformed. Not expected from this read; declared because every provisioner refusal is mapped the same way.",
      "name": "InvalidRequest"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NotFound"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "InvalidSlug"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "SlugTaken"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NotEntitled"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "InstanceLimit"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NoCapacity"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "OperationInProgress"
    },
    {
      "description": "The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.",
      "name": "Upstream"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "instanceCount": {
          "description": "Instances counting against the limit. 0 for a non-customer.",
          "type": "integer"
        },
        "instanceLimit": {
          "description": "The most instances the caller may have. 0 for a non-customer.",
          "type": "integer"
        },
        "isCustomer": {
          "description": "Whether the caller may use the customer endpoints.",
          "type": "boolean"
        }
      },
      "required": [
        "isCustomer",
        "instanceCount",
        "instanceLimit"
      ],
      "type": "object"
    }
  },
  "type": "query"
}