Get profile information for a user

GET/users/{userId}/

API version

v2

Request method

GET

Operation ID

user-get-user

---

Request

• userIdstring

  required

  self or the id of a user.

Responses

Format

application/json

Description

The user profile.

Schema documentation

• avatarRefstring (uuid)
• customerMembershipsobject
  • *object
    • expiresAtstring (date-time)
    • memberSincestring (date-time)

      required
    • rolestring (one of: owner, member, accountant)

      required
• emailstring (email)
• employeeInformationobject

  Additional information about mittwald employees.

  • departmentstring

    required
• isEmployeeboolean

  Truth value, whether the user is a mittwald employee

• mfaobject
  • activeboolean

    required
  • setupboolean

    required
• passwordUpdatedAtstring (date-time)
• personobject

  required

  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)
• phoneNumberstring
• projectMembershipsobject
  • *object
    • expiresAtstring (date-time)
    • inheritedboolean

      required
    • memberSincestring (date-time)

      required
    • rolestring (one of: owner, emailadmin, external)

      required
• registeredAtstring (date-time)
• userIdstring (uuid)

  required

Example

{
  "avatarRef": "f0f86186-0a5a-45b2-aa33-502777496347",
  "customerMemberships": {
    "string": {
      "expiresAt": "2024-12-18T07:53:23.611Z",
      "memberSince": "2024-12-18T07:53:23.611Z",
      "role": "owner"
    }
  },
  "email": "email@mittwald.example",
  "employeeInformation": {
    "department": "Kundenservice"
  },
  "isEmployee": true,
  "mfa": {
    "active": true,
    "setup": true
  },
  "passwordUpdatedAt": "2024-12-18T07:53:23.611Z",
  "person": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "title": "mr"
  },
  "phoneNumber": "+491701234567",
  "projectMemberships": {
    "string": {
      "expiresAt": "2024-12-18T07:53:23.611Z",
      "inherited": true,
      "memberSince": "2024-12-18T07:53:23.611Z",
      "role": "owner"
    }
  },
  "registeredAt": "2024-12-18T07:53:23.611Z",
  "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "avatarRef": {
      "format": "uuid",
      "type": "string"
    },
    "customerMemberships": {
      "additionalProperties": {
        "properties": {
          "expiresAt": {
            "format": "date-time",
            "type": "string"
          },
          "memberSince": {
            "format": "date-time",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "member",
              "accountant"
            ],
            "type": "string"
          }
        },
        "required": [
          "role",
          "memberSince"
        ],
        "type": "object"
      },
      "type": "object"
    },
    "email": {
      "format": "email",
      "type": "string"
    },
    "employeeInformation": {
      "description": "Additional information about mittwald employees.",
      "properties": {
        "department": {
          "example": "Kundenservice",
          "type": "string"
        }
      },
      "required": [
        "department"
      ],
      "type": "object"
    },
    "isEmployee": {
      "description": "Truth value, whether the user is a mittwald employee",
      "type": "boolean"
    },
    "mfa": {
      "properties": {
        "active": {
          "default": false,
          "type": "boolean"
        },
        "setup": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "active",
        "setup"
      ],
      "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"
      ]
    },
    "phoneNumber": {
      "example": "+491701234567",
      "type": "string"
    },
    "projectMemberships": {
      "additionalProperties": {
        "properties": {
          "expiresAt": {
            "format": "date-time",
            "type": "string"
          },
          "inherited": {
            "type": "boolean"
          },
          "memberSince": {
            "format": "date-time",
            "type": "string"
          },
          "role": {
            "enum": [
              "owner",
              "emailadmin",
              "external"
            ],
            "type": "string"
          }
        },
        "required": [
          "role",
          "memberSince",
          "inherited"
        ],
        "type": "object"
      },
      "type": "object"
    },
    "registeredAt": {
      "format": "date-time",
      "type": "string"
    },
    "userId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "userId",
    "person"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/users/string

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.getUser({
  "userId": "string"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetUserRequest(
  userId: "string"
));
$response = $client->user()->getUser($request);

var_dump($response->getBody();