List customer memberships belonging to the executing user

GET/customer-memberships/

API version

v2

Request method

GET

Operation ID

customer-list-customer-memberships

---

Request

Responses

Response headers

• X-Pagination-Limitinteger
• X-Pagination-Pageinteger
• X-Pagination-Skipinteger
• X-Pagination-TotalCountinteger

Format

application/json

Description

OK

Schema documentation

• Array[
  • *object
    • avatarRefstring (uuid)

      Avatar file reference id of the user.

    • customerIdstring (uuid)

      required

      ID of the Customer the CustomerMembership is for.

    • emailstring (email)

      required

      Email used by the invited user.

    • expiresAtstring (date-time)

      Time the CustomerMembership should expire at.

    • firstNamestring

      required

      First name of the user.

    • idstring (uuid)

      required

      ID of the CustomerMembership.

    • inviteIdstring (uuid)

      ID of the CustomerInvite the membership was created from.

    • lastNamestring

      required

      Last name of the user.

    • memberSincestring (date-time)

      Date the CustomerMembership was created at.

    • mfaboolean

      required

      MFA activated by the user.

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

      required
    • userIdstring (uuid)

      required

      ID of the user the CustomerMembership is for.

  ]

Example

Content-Type: application/json

[
  {
    "avatarRef": "f0f86186-0a5a-45b2-aa33-502777496347",
    "customerId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "email": "email@mittwald.example",
    "expiresAt": "1985-10-26T01:21:00.000Z",
    "firstName": "string",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "inviteId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "lastName": "string",
    "memberSince": "1985-10-26T01:21:00.000Z",
    "mfa": true,
    "role": "notset",
    "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "avatarRef": {
        "description": "Avatar file reference id of the user.",
        "format": "uuid",
        "type": "string"
      },
      "customerId": {
        "description": "ID of the Customer the CustomerMembership is for.",
        "format": "uuid",
        "type": "string"
      },
      "email": {
        "description": "Email used by the invited user.",
        "format": "email",
        "type": "string"
      },
      "expiresAt": {
        "description": "Time the CustomerMembership should expire at.",
        "format": "date-time",
        "type": "string"
      },
      "firstName": {
        "description": "First name of the user.",
        "type": "string"
      },
      "id": {
        "description": "ID of the CustomerMembership.",
        "format": "uuid",
        "type": "string"
      },
      "inviteId": {
        "description": "ID of the CustomerInvite the membership was created from.",
        "format": "uuid",
        "type": "string"
      },
      "lastName": {
        "description": "Last name of the user.",
        "type": "string"
      },
      "memberSince": {
        "description": "Date the CustomerMembership was created at.",
        "format": "date-time",
        "type": "string"
      },
      "mfa": {
        "description": "MFA activated by the user.",
        "type": "boolean"
      },
      "role": {
        "enum": [
          "notset",
          "owner",
          "member",
          "accountant"
        ],
        "type": "string"
      },
      "userId": {
        "description": "ID of the user the CustomerMembership is for.",
        "format": "uuid",
        "type": "string"
      }
    },
    "required": [
      "id",
      "customerId",
      "userId",
      "role",
      "email",
      "mfa",
      "firstName",
      "lastName"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customer-memberships?limit=50&page=1&hasExpiry=true&role=notset

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.customer.listCustomerMemberships({
  "queryParameters": {
    "limit": 50,
    "page": 1,
    "hasExpiry": true,
    "role": "notset"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Customer\ListCustomerMemberships\ListCustomerMembershipsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListCustomerMembershipsRequest())
  ->withLimit(50)
  ->withPage(1)
  ->withHasExpiry(true)
  ->withRole("notset");
$response = $client->customer()->listCustomerMemberships($request);

var_dump($response->getBody();