List customers

Customers API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for listing customers in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/customers
Authentication:API keysApp access tokens

Retrieve all customers created.

The results are paginated. See pagination for more information.

Parameters

offsetintegeroptional
The number of customers to skip.
countintegeroptional
The number of customers to return (with a maximum of 250).

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the testmode query string parameter is also available.

testmodebooleanoptional

Response

200 application/json

totalCountinteger
The total number of customers available.
offsetinteger
The number of skipped customers as requested.
countinteger
The number of customers found in data, which is either the requested number (with a maximum of 250) or the default number.
dataarray
An array of customers objects as described in Get customer.
linksobject

Links to help navigate through the lists of customers, based on the given offset.

Show child parameters

previousstring
The previous set of customers, if available.
nextstring
The next set of customers, if available.
firststring
The first set of customers, if available.
laststring
The last set of customers, if available.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/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
HTTP/1.1 200 OK
Content-Type: application/json

{
    "totalCount": 3,
    "offset": 0,
    "count": 3,
    "data": [
        {
            "resource": "customer",
            "id": "cst_vsKJpSsabw",
            "mode": "test",
            "name": "Customer A",
            "email": "customer@example.org",
            "locale": "nl_NL",
            "metadata": null,
            "recentlyUsedMethods": [
                "creditcard",
                "ideal"
            ],
            "createdDatetime": "2016-04-06T13:23:21.0Z"
        },
        { },
        { }
    ]
}