Get client

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

Retrieve a single client, linked to your partner account, by its ID.

Parameters

Replace id in the endpoint URL by the client’s ID, for example org_1337.

Response

200 application/hal+json

resourcestring
Indicates the response contains a client object. Will always contain client for this endpoint.
idstring
The unique identifier of the client, which corresponds to the ID of the organization, for example org_1337.
organizationCreatedAtdateoptional
The date and time the organization was created, in ISO 8601 format. Only returned when one of the embeds is available.
_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 API resource URL of the client itself.
organizationURL objectoptional
The API resource URL of the client’s organization. Only available when the include could have been used.
onboardingURL objectoptional
The API resource URL of the client’s onboarding status. Only available when the include could have been used.
documentationURL object
The URL to the documentation of this endpoint.

Example

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

{
    "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"
        }
    }
}