MOmollie
Profiles API

List profiles

Changed on

Retrieve a list of all of your profiles.

The results are paginated.

get/v2/profiles

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/profiles
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: profiles.read

Query parameters

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 profile objects.

countinteger required

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": {
    "profiles": [
      {
        "resource": "profile",
        "id": "pfl_QkEhN94Ba",
        "mode": "live",
        "name": "My website name",
        "website": "https://example.com",
        "email": "test@mollie.com",
        "phone": "+31208202070",
        "description": "My website description",
        "countriesOfActivity": [
          "NL",
          "GB"
        ],
        "businessCategory": "OTHER_MERCHANDISE",
        "status": "unverified",
        "review": {
          "status": "pending"
        },
        "createdAt": "2024-03-20T09:13:37+00:00",
        "_links": {
          "self": {
            "href": "...",
            "type": "application/hal+json"
          },
          "dashboard": {
            "href": "https://www.mollie.com/dashboard/org_7049691/settings/profiles/pfl_2q3RyuMGry",
            "type": "text/html"
          },
          "chargebacks": {
            "href": "https://api.mollie.com/v2/chargebacks?profileId=pfl_2q3RyuMGry",
            "type": "application/hal+json"
          },
          "methods": {
            "href": "https://api.mollie.com/v2/methods?profileId=pfl_2q3RyuMGry",
            "type": "application/hal+json"
          },
          "payments": {
            "href": "https://api.mollie.com/v2/payments?profileId=pfl_2q3RyuMGry",
            "type": "application/hal+json"
          },
          "refunds": {
            "href": "https://api.mollie.com/v2/refunds?profileId=pfl_2q3RyuMGry",
            "type": "application/hal+json"
          },
          "checkoutPreviewUrl": {
            "href": "https://www.mollie.com/checkout/preview/pfl_2q3RyuMGry",
            "type": "text/html"
          },
          "documentation": {
            "href": "...",
            "type": "text/html"
          }
        }
      }
    ]
  },
  "_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

  • 1bcb76dbe9eaRevision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status

  • 19423176b0c3Revision changes
    • breaking

      the response property /////// became nullable for the status