List customers

Customers API v2
GEThttps://api.mollie.com/v2/customers

Retrieve all customers created.

The results are paginated. See pagination for more information.

Parameters

from

string
optional
Offset the result set to the customer with this ID. The customer with this ID is included in the result set as well.

limit

integer
optional
The number of customers to return (with a maximum of 250).

Mollie Connect/OAuth parameters

If you’re creating an app with Mollie Connect/OAuth, the testmode parameter is also available.

testmode

boolean
optional
Set this to true to list test mode customers.

Response

200 application/hal+json; charset=utf-8

count

integer
The number of customers found in _embedded, which is either the requested number (with a maximum of 250) or the default number.

_embedded

object

The object containing the queried data.

customers

array
An array of customer objects as described in Get customer.

_links

object

Links to help navigate through the lists of customers. Every URL object will contain an href and a type field.

self

URL object
The URL to the current set of customers.

previous

URL object
The previous set of customers, if available.

next

URL object
The next set of customers, if available.

documentation

URL object
The URL to the customers list endpoint documentation.

Example

Request

1
2
curl -X GET https://api.mollie.com/v2/customers \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
HTTP/1.1 200 OK
Content-Type: application/hal+json; charset=utf-8

{
    "count": 3,
    "_embedded": {
        "customers": [
            {
                "resource": "customer",
                "id": "cst_kEn1PlbGa",
                "mode": "test",
                "name": "Customer A",
                "email": "customer@example.org",
                "locale": "nl_NL",
                "metadata": null,
                "recentlyUsedMethods": [
                    "creditcard",
                    "ideal"
                ],
                "createdAt": "2018-04-06T13:23:21.0Z",
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/customers/cst_kEn1PlbGa",
                        "type": "application/hal+json"
                    },
                    "documentation": {
                        "href": "https://docs.mollie.com/reference/v2/customers-api/get-customer",
                        "type": "text/html"
                    }
                }
            },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/customers",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/customers?from=cst_stTC2WHAuS",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/customers-api/list-customers",
            "type": "text/html"
        }
    }
}