Get all customer profiles the authenticated user has access to

GET/customers/

API version

v2

Request method

GET

Operation ID

customer-list-customers

---

Request

Responses

Response headers

• X-Pagination-Limitnumber

  The limit used to select the resources for the response

• X-Pagination-Skipnumber

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountnumber

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

The list of customers the authenticated user is a member for

Schema documentation

• Array[
• *object
  • activeSuspensionobject
    • createdAtstring (date-time)

      required
  • avatarRefIdstring
  • categoryIdstring
  • creationDatestring (date-time)

    required
  • customerIdstring

    required
  • customerNumberstring

    required
  • executingUserRolesarray of string (one of: owner, member, accountant)
    • Array[
    • *string (one of: owner, member, accountant)

      the role within a customer

    ]
• isBannedboolean
• isInDefaultOfPaymentboolean
• memberCountinteger (≥ 0)

  required
• namestring

  required
• ownerobject
  • addressobject

    required
    • streetstring

      required
    • houseNumberstring

      required
    • citystring

      required
    • zipstring

      required
    • countryCodestring

      required

      ISO 3166-1 alpha-2 country code

    • addressPrefixstring
  • companystring
  • emailAddressstring (email)
  • firstNamestring
  • lastNamestring
  • phoneNumbersarray of string
    • Array[
    • *string
    ]
• salutationstring (one of: mr, ms, other)

  required
• titlestring
• useFormalTermboolean

projectCountinteger (≥ 0)

required

vatIdstring

vatIdValidationStatestring (one of: valid, invalid, pending, unspecified)

]

Example

[
  {
    "activeSuspension": {
      "createdAt": "2024-11-21T11:15:05.985Z"
    },
    "avatarRefId": "string",
    "categoryId": "string",
    "creationDate": "2024-11-21T11:15:05.985Z",
    "customerId": "string",
    "customerNumber": "string",
    "executingUserRoles": [
      "owner"
    ],
    "isBanned": true,
    "isInDefaultOfPayment": true,
    "memberCount": 123,
    "name": "string",
    "owner": {
      "address": {
        "street": "Königsberger Straße",
        "houseNumber": "4-6",
        "city": "Espelkamp",
        "zip": "32339",
        "countryCode": "DE",
        "addressPrefix": "c/o Ada Lovelace"
      },
      "company": "string",
      "emailAddress": "email@mittwald.example",
      "firstName": "string",
      "lastName": "string",
      "phoneNumbers": [
        "string"
      ],
      "salutation": "mr",
      "title": "string",
      "useFormalTerm": true
    },
    "projectCount": 123,
    "vatId": "string",
    "vatIdValidationState": "valid"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "activeSuspension": {
        "properties": {
          "createdAt": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "createdAt"
        ],
        "type": "object"
      },
      "avatarRefId": {
        "type": "string"
      },
      "categoryId": {
        "type": "string"
      },
      "creationDate": {
        "format": "date-time",
        "type": "string"
      },
      "customerId": {
        "type": "string"
      },
      "customerNumber": {
        "type": "string"
      },
      "executingUserRoles": {
        "items": {
          "description": "the role within a customer",
          "enum": [
            "owner",
            "member",
            "accountant"
          ],
          "type": "string"
        },
        "type": "array"
      },
      "isBanned": {
        "type": "boolean"
      },
      "isInDefaultOfPayment": {
        "type": "boolean"
      },
      "memberCount": {
        "minimum": 0,
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "owner": {
        "properties": {
          "address": {
            "type": "object",
            "properties": {
              "street": {
                "type": "string",
                "example": "Königsberger Straße"
              },
              "houseNumber": {
                "type": "string",
                "example": "4-6"
              },
              "city": {
                "type": "string",
                "example": "Espelkamp"
              },
              "zip": {
                "type": "string",
                "example": "32339"
              },
              "countryCode": {
                "type": "string",
                "example": "DE",
                "description": "ISO 3166-1 alpha-2 country code"
              },
              "addressPrefix": {
                "type": "string",
                "example": "c/o Ada Lovelace"
              }
            },
            "required": [
              "street",
              "houseNumber",
              "city",
              "zip",
              "countryCode"
            ]
          },
          "company": {
            "type": "string"
          },
          "emailAddress": {
            "format": "email",
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "phoneNumbers": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "salutation": {
            "type": "string",
            "enum": [
              "mr",
              "ms",
              "other"
            ]
          },
          "title": {
            "type": "string"
          },
          "useFormalTerm": {
            "type": "boolean"
          }
        },
        "required": [
          "address",
          "salutation"
        ],
        "type": "object"
      },
      "projectCount": {
        "minimum": 0,
        "type": "integer"
      },
      "vatId": {
        "type": "string"
      },
      "vatIdValidationState": {
        "enum": [
          "valid",
          "invalid",
          "pending",
          "unspecified"
        ],
        "type": "string"
      }
    },
    "required": [
      "customerId",
      "customerNumber",
      "name",
      "creationDate",
      "memberCount",
      "projectCount"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers?role=string&search=string&limit=50&page=1

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.listCustomers({
  "queryParameters": {
    "role": "string",
    "search": "string",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListCustomersRequest())
  ->withRole("string")
  ->withSearch("string")
  ->withLimit(50)
  ->withPage(1);
$response = $client->customer()->listCustomers($request);

var_dump($response->getBody();