Get your account information

GET/users/self/personal-information/

API version

v2

Request method

GET

Operation ID

user-get-own-account

---

Request

Responses

Format

application/json

Beschreibung

Account information.

Schema-Dokumentation

• emailstring (email)
• mfaDetailsobject

  The users mfa details.

  • mfaConfirmedboolean
  • mfaInitializedboolean
• passwordUpdatedAtstring (date-time)
• personobject

  The users personal information, e.g. first name.

  • firstNamestring

    required

    The users first name

  • lastNamestring

    required

    The users last name

  • titlestring (one of: mr, ms, other)
• userIdstring

Beispiel

{
  "email": "a.lovelace@example.com",
  "mfaDetails": {
    "mfaConfirmed": true,
    "mfaInitialized": true
  },
  "passwordUpdatedAt": "2024-11-08T18:11:54.965Z",
  "person": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "title": "mr"
  },
  "userId": "string"
}

JSON Schema

{
  "properties": {
    "email": {
      "example": "a.lovelace@example.com",
      "format": "email",
      "type": "string"
    },
    "mfaDetails": {
      "description": "The users mfa details.",
      "properties": {
        "mfaConfirmed": {
          "type": "boolean"
        },
        "mfaInitialized": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "passwordUpdatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "person": {
      "type": "object",
      "description": "The users personal information, e.g. first name.",
      "properties": {
        "firstName": {
          "type": "string",
          "description": "The users first name",
          "example": "Ada"
        },
        "lastName": {
          "type": "string",
          "description": "The users last name",
          "example": "Lovelace"
        },
        "title": {
          "type": "string",
          "enum": [
            "mr",
            "ms",
            "other"
          ]
        }
      },
      "required": [
        "lastName",
        "firstName"
      ]
    },
    "userId": {
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -d '{}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/self/personal-information

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.getOwnAccount({
  "data": {}
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\GetOwnAccount\GetOwnAccountRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\GetOwnAccount\GetOwnAccountRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// GetOwnAccountRequestBody to learn how to construct a valid instance
$body = new GetOwnAccountRequestBody(/* TODO: ... */);

$request = (new GetOwnAccountRequest(
  body: $body
));
$response = $client->user()->getOwnAccount($request);

var_dump($response->getBody();