MOmollie
Customers API

List customers

Changed on

Retrieve a list of all customers.

The results are paginated.

get/v2/customers

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/customers
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: customers.read

Query parameters

fromstring
Example:cst_5B8cwPMGnU

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

sort'asc' | 'desc'
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of customer objects.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "customers": [
      {
        "resource": "customer",
        "id": "cst_5B8cwPMGnU",
        "mode": "live",
        "name": "John Doe",
        "email": "example@email.com",
        "locale": "en_US",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "dashboard": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "payments": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "mandates": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "subscriptions": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 9c1c6717ac7dRevision changes
    • warning

      added the new el_GR enum value to the /////// response property for the response status

    • warning

      added the new sl_SI enum value to the /////// response property for the response status

    • warning

      added the new tr_TR enum value to the /////// response property for the response status

  • 86a9cd830b06Revision changes
    • warning

      added the new en_BE enum value to the /////// response property for the response status

    • warning

      added the new en_NL enum value to the /////// response property for the response status