List profiles

Profiles API v2
GEThttps://api.mollie.com/v2/profiles

Retrieve all profiles available on the account.

The results are paginated. See pagination for more information.

Parameters

from

string
optional
Offset the result set to the profile with this ID. The profile with this ID is included in the result set as well.

limit

integer
optional
The number of profiles to return (with a maximum of 250).

Response

200 application/hal+json

count

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

_embedded

object

The object containing the queried data.

profiles

array
An array of profile objects as described in Get profile.

_links

object

Links to help navigate through the lists of profiles. Every URL object will contain an href and a type field.

self

URL object
The URL to the current set of profiles.

previous

URL object
The previous set of profiles, if available.

next

URL object
The next set of profiles, if available.

documentation

URL object
The URL to the profiles list endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/profiles?limit=5 \
   -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$profiles = $mollie->profiles->page();
1
2
3
4
5
6
7
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ'
end

profiles = Mollie::Profile.all
1
2
3
4
We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "_embedded": {
        "profiles": [
            {
                "resource": "profiles",
                "id": "pfl_v9hTwCvYqw",
                "mode": "live",
                "name": "My website name",
                "website": "https://www.mywebsite.com",
                "email": "info@mywebsite.com",
                "phone": "+31208202070",
                "categoryCode": 5399,
                "status": "verified",
                "review": {
                    "status": "pending"
                },
                "createdAt": "2018-03-20T09:28:37+00:00",
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/profiles/pfl_v9hTwCvYqw",
                        "type": "application/hal+json"
                    },
                    "chargebacks": {
                        "href": "https://api.mollie.com/v2/chargebacks?profileId=pfl_v9hTwCvYqw",
                        "type": "application/hal+json"
                    },
                    "methods": {
                        "href": "https://api.mollie.com/v2/methods?profileId=pfl_v9hTwCvYqw",
                        "type": "application/hal+json"
                    },
                    "payments": {
                        "href": "https://api.mollie.com/v2/payments?profileId=pfl_v9hTwCvYqw",
                        "type": "application/hal+json"
                    },
                    "refunds": {
                        "href": "https://api.mollie.com/v2/refunds?profileId=pfl_v9hTwCvYqw",
                        "type": "application/hal+json"
                    },
                    "checkoutPreviewUrl": {
                        "href": "https://www.mollie.com/payscreen/preview/pfl_v9hTwCvYqw",
                        "type": "text/html"
                    },
                    "documentation": {
                        "href": "https://docs.mollie.com/reference/v2/profiles-api/create-profile",
                        "type": "text/html"
                    }
                }
            },
            { },
            { },
            { },
            { }
        ]
    },
    "count": 5,
    "_links": {
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/profiles-api/list-profiles",
            "type": "text/html"
        },
        "self": {
            "href": "https://api.mollie.com/v2/profiles?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/profiles?from=pfl_3RkSN1zuPE&limit=5",
            "type": "application/hal+json"
        }
    }
}