GET /api/v1/account

Operation: getAccount.

Profile/security metadata (self); no password/token hashes

Endpoint

GET https://amplerun-api.spiry.org/api/v1/account

Authentication

Use the credential and scope required by this operation. For programmatic renter/host calls: Authorization: Bearer $AMPLERUN_API_KEY. A host-agent signature or other specialized proof is required where the description specifies it.

Responses

200

Account profile.

application/json

Field	Type	Presence	Description
account_id	string	Required
email	string	Required	A wallet-created account without an email has a non-routable placeholder ending in @wallet.placeholder.invalid (RFC 6761).
role	“renter” / “host” / “admin”	Required
host_enabled	boolean	Required
email_verified	boolean	Required	Quotes, reservations and funding require a verified email or a wallet-created account; hosting requires a verified email.
two_factor_enabled	boolean	Required
auth_method	“session” / “api-key”	Required	How this request authenticated.
step_up_method	“totp” / “password” / “wallet” / “none”	Required	The proof POST /api/v1/account/step-up asks for. wallet is a fresh EIP-4361 signature from the wallet a wallet-created account signs in with.
name	string	Optional	Display name from sign-up or the social provider; null when none was given.
account_kind	“human” / “agent”	Optional	Who opened the account: a person, or an agent through self-registration.
created_at	string	Optional	When the account was created (member since).

{
  "type": "object",
  "required": [
    "account_id",
    "email",
    "role",
    "host_enabled",
    "email_verified",
    "two_factor_enabled",
    "auth_method",
    "step_up_method"
  ],
  "properties": {
    "account_id": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "description": "A wallet-created account without an email has a non-routable placeholder ending in @wallet.placeholder.invalid (RFC 6761)."
    },
    "role": {
      "enum": [
        "renter",
        "host",
        "admin"
      ]
    },
    "host_enabled": {
      "type": "boolean"
    },
    "email_verified": {
      "type": "boolean",
      "description": "Quotes, reservations and funding require a verified email or a wallet-created account; hosting requires a verified email."
    },
    "two_factor_enabled": {
      "type": "boolean"
    },
    "auth_method": {
      "enum": [
        "session",
        "api-key"
      ],
      "description": "How this request authenticated."
    },
    "step_up_method": {
      "enum": [
        "totp",
        "password",
        "wallet",
        "none"
      ],
      "description": "The proof POST /api/v1/account/step-up asks for. wallet is a fresh EIP-4361 signature from the wallet a wallet-created account signs in with."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "description": "Display name from sign-up or the social provider; null when none was given."
    },
    "account_kind": {
      "enum": [
        "human",
        "agent"
      ],
      "description": "Who opened the account: a person, or an agent through self-registration."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the account was created (member since)."
    }
  }
}

default

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

application/json

Field	Type	Presence	Description
error	object	Required

{
  "$ref": "#/components/schemas/ErrorEnvelope"
}

Static request outline

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

curl --request GET 'https://amplerun-api.spiry.org/api/v1/account' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery