List clients

Clients API v2
GEThttps://api.mollie.com/v2/clients

Retrieve all clients linked to your partner account.

The results are paginated. See pagination for more information.

Parameters

fromstringoptional
Used for pagination. Offset the result set to the client with this ID. The client with this ID is included in the result set as well.
limitintegeroptional
The number of clients to return (with a maximum of 250).
yearintegeroptional
Show the statistics for the given year.
monthintegeroptional
Show the statistics for the given month.

Response

200 application/hal+json

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

The object containing the queried data.

Hide child parameters

clientsarray
An array of client objects as described in Get client.
_linksobject

An object with several URL objects relevant to the client resource. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The URL to the current set of clients.
previousURL object
The previous set of clients, if available.
nextURL object
The next set of clients, if available.
documentationURL object
The URL to the documentation of this endpoint.

Example

1
2
curl -X GET https://api.mollie.com/v2/clients?limit=3 \
   -H "Authorization: Bearer access_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
52
53
54
55
56
57
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 3,
    "_embedded": {
        "clients": [
            {
                "resource": "client",
                "id": "org_1337",
                "organizationCreatedAt": "2018-03-21T13:13:37+00:00",
                "commission": {
                    "count": 200,
                    "totalAmount": {
                        "currency": "EUR",
                        "value": "10.00"
                    }
                },
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/clients/org_1337",
                        "type": "application/hal+json"
                    },
                    "organization": {
                        "href": "https://api.mollie.com/v2/organizations/org_1337",
                        "type": "application/hal+json"
                    },
                    "onboarding": {
                        "href": "https://api.mollie.com/v2/onboarding/org_1337",
                        "type": "application/hal+json"
                    },
                    "documentation": {
                        "href": "https://docs.mollie.com/reference/v2/clients-api/get-client",
                        "type": "text/html"
                    }
                }
            },
            { },
            { }
        ],
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/clients?limit=3",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/clients?from=org_1379&limit=3",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/clients-api/list-clients",
            "type": "text/html"
        }
    }
}