Clients API

List clients

Retrieve a list of all clients linked to your account.

The results are paginated.

🔑 Access with

Advanced access token with clients.read

get/v2/clients

Request

Base URL
https://api.mollie.com
URL
https://api.mollie.com/v2/clients
Auth
HTTP bearer

Query parameters

embedstring nullable

Example:organization

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

organization: Include the organization of the client. Available for signuplink partners, or for oauth partners with the organizations.read scope.
onboarding: Include the onboarding status of the client. Available for signuplink partners, or for oauth partners with the onboarding.read scope.
capabilities: Include the capabilities of the client organization. Available for oauth partners with the onboarding.read scope.

fromstring

Example:org_12345678

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.

Response

A list of client objects. For a complete reference of the client object, refer to the Get client endpoint documentation.

countinteger

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": {
    "clients": [
      {
        "id": "org_1234567",
        "commission": {
          "count": 10
        },
        "organizationCreatedAt": "2023-01-15T13:45:30+00:00",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "organization": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "onboarding": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        },
        "_embedded": {
          "organization": {
            "id": "org_1234567",
            "name": "My Online Store",
            "email": "example@mail.com",
            "locale": "en_US",
            "address": {
              "streetAndNumber": "Keizersgracht 126",
              "postalCode": "1015 CW",
              "city": "Amsterdam",
              "country": "NL"
            },
            "registrationNumber": "12345678",
            "vatNumber": "NL123456789B01",
            "vatRegulation": "dutch",
            "_links": {
              "self": {
                "href": "https://...",
                "type": "application/hal+json"
              },
              "dashboard": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          },
          "onboarding": {
            "name": "My webshop",
            "status": "completed",
            "canReceivePayments": true,
            "canReceiveSettlements": true,
            "signedUpAt": "2023-01-15T13:45:30+00:00",
            "_links": {
              "self": {
                "href": "https://...",
                "type": "application/hal+json"
              },
              "dashboard": {
                "href": "https://...",
                "type": "application/hal+json"
              },
              "organization": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          },
          "capabilities": [
            {
              "resource": "capability",
              "name": "payments",
              "status": "pending",
              "statusReason": "requirement-past-due",
              "requirements": [
                {
                  "id": "needs-data",
                  "status": "past-due",
                  "dueDate": "2024-01-01T12:00:00+00:00",
                  "_links": {
                    "dashboard": {
                      "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

No recorded changes to this operation across all 1 revision of this API.