Retrieve All Users

GET https://sandbox.bluesnap.com/services/2

Definition

https://sandbox.bluesnap.com/services/2/cp/user/all

---

Documentation

The BlueSnap Retrieve All Users API enables you to retrieve all existing users in your BlueSnap account or any of your linked accounts.

Request Content

No content is required in the request body.

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the details on all the retrieved users.

📘

Note:

The response may include User Permissions information as applicable per user.

---

Examples

Request Example

📘

Note:

If you need to manage an operation on behalf of a linked BlueSnap account, use the onbehalfofmid parameter.

Retrieve All Users

curl -v -X GET https://sandbox.bluesnap.com/services/2/cp/user/all
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Retrieve all users on behalf of linked BlueSnap account

curl -v -X GET https://sandbox.bluesnap.com/services/2/cp/user/all?onbehalfofmid=34234
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Example

If successful, the response HTTP status code is 200 OK.

Retrieve User Response: 200 OK

[
	{
        "userId: "11111001",
        "firstName": "New",
        "lastName": "User",
        "email": "[email protected]",
        "username": "finance1234”,
        "allowViewFinansialInfo": true,
        "allowReports": false
    }
	{
	    "userId: "11111002",
		"firstName": "New2",
        "lastName": "User2",
        "email": "[email protected]",
        "username": "finance5678”,
        "admin": true
		}
]

Parameter Reference

Parameter	Description
onbehalfofmid	Creates, updates, retrieves, or deletes users on behalf of a linked BlueSnap account Note: This parameter specifies the ID of the BlueSnap account that owns the user, which should be linked to the BlueSnap account executing the call.