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-Header

• X-Pagination-Limitnumber
• X-Pagination-Skipnumber
• X-Pagination-TotalCountnumber

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• Array[
• *object
  • 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.

  • idstring (uuid)

    required

    ID of the CustomerMembership.

  • inviteIdstring (uuid)

    ID of the CustomerInvite the membership was created from.

  • 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.

]

Beispiel

[
  {
    "customerId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "email": "email@mittwald.example",
    "expiresAt": "2024-11-24T00:36:07.170Z",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "inviteId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "memberSince": "2024-11-24T00:36:07.170Z",
    "mfa": true,
    "role": "notset",
    "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "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"
      },
      "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"
      },
      "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"
    ],
    "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

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
  }
});

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);
$response = $client->customer()->listCustomerMemberships($request);

var_dump($response->getBody();