MOmollie
Clients API

List clients

Changed on

Retrieve a list of all clients linked to your account.

The results are paginated.

get/v2/clients

Request

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

Query parameters

embedstring nullable

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

fromstring nullable

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.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

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": [
      {
        "resource": "client",
        "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": {
            "resource": "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"
              },
              "documentation": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          },
          "onboarding": {
            "resource": "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"
              },
              "documentation": {
                "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

  • 9c1c6717ac7dRevision changes
    • warning

      added the new el_GR enum value to the ////////// response property for the response status

    • warning

      added the new sl_SI enum value to the ////////// response property for the response status

    • warning

      added the new tr_TR enum value to the ////////// response property for the response status

  • 86a9cd830b06Revision changes
    • warning

      added the new en_BE enum value to the ////////// response property for the response status

    • warning

      added the new en_NL enum value to the ////////// response property for the response status