GET
/
v2.01
/
{ClientId}
/
users
// GET has no body parameters

[ 
   {
       "Id": "158026537",
       "Tag": "Created using MANGOPAY API Collection Postman",
       "CreationDate": 1670863988,
       "PersonType": "LEGAL",
       "Email": "richard.moulin@email.com",
       "KYCLevel": "LIGHT",
       "TermsAndConditionsAccepted": false,
       "TermsAndConditionsAcceptedDate": null,
       "UserCategory": "PAYER",
       "UserStatus": "ACTIVE"
   },
   {
       "Id": "158025445",
       "Tag": "Created using MANGOPAY API Collection Postman",
       "CreationDate": 1670862022,
       "PersonType": "NATURAL",
       "Email": "email@test.com",
       "KYCLevel": "LIGHT",
       "TermsAndConditionsAccepted": true,
       "TermsAndConditionsAcceptedDate": 1670862022,
       "UserCategory": "OWNER",
       "UserStatus": "ACTIVE"
   },
   {
       "Id": "158026721",
       "Tag": "Created using MANGOPAY API Collection Postman",
       "CreationDate": 1670864174,
       "PersonType": "LEGAL",
       "Email": "cortney_douglas@yahoo.com",
       "KYCLevel": "REGULAR",
       "TermsAndConditionsAccepted": true,
       "TermsAndConditionsAcceptedDate": 1670864174,
       "UserCategory": "OWNER",
       "UserStatus": "ACTIVE"
   }
]

This endpoint returns key information for each user created by the platform.

​
Query parameters

​
page
integer

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

​
per_page
integer

Max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

​
Sort
string

Allowed values: CreationDate:ASC, CreationDate:DESC

Indicates the direction in which to sort the list.

​
Responses

​
Array (Users)
array

The list of users created by the platform.

[ 
   {
       "Id": "158026537",
       "Tag": "Created using MANGOPAY API Collection Postman",
       "CreationDate": 1670863988,
       "PersonType": "LEGAL",
       "Email": "richard.moulin@email.com",
       "KYCLevel": "LIGHT",
       "TermsAndConditionsAccepted": false,
       "TermsAndConditionsAcceptedDate": null,
       "UserCategory": "PAYER",
       "UserStatus": "ACTIVE"
   },
   {
       "Id": "158025445",
       "Tag": "Created using MANGOPAY API Collection Postman",
       "CreationDate": 1670862022,
       "PersonType": "NATURAL",
       "Email": "email@test.com",
       "KYCLevel": "LIGHT",
       "TermsAndConditionsAccepted": true,
       "TermsAndConditionsAcceptedDate": 1670862022,
       "UserCategory": "OWNER",
       "UserStatus": "ACTIVE"
   },
   {
       "Id": "158026721",
       "Tag": "Created using MANGOPAY API Collection Postman",
       "CreationDate": 1670864174,
       "PersonType": "LEGAL",
       "Email": "cortney_douglas@yahoo.com",
       "KYCLevel": "REGULAR",
       "TermsAndConditionsAccepted": true,
       "TermsAndConditionsAcceptedDate": 1670864174,
       "UserCategory": "OWNER",
       "UserStatus": "ACTIVE"
   }
]  


// GET has no body parameters

Was this page helpful?

View a User (SCA)The Natural User object