Definition
https://sandbox.bluesnap.com/services/2/cp/user/
Documentation
The BlueSnap Retrieve User API enables you to retrieve an existing user in your BlueSnap account or any of your linked accounts.
Request Content
No content is required in the request body. Enter the relevant IDs in the request URL, as follows:
Retrieve based on User ID
Enter the userId into the web service URL, in the format:
services/2/cp/user/{userId}
For example:
services/2/cp/user/1011582369
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the details on the retrieved userId object.
Examples
Request Example
Note:
If you need to manage an operation on behalf of a linked BlueSnap account, use the "onbehalfofmid" parameter.
curl -v -X GET https://sandbox.bluesnap.com/services/2/cp/user/23645623
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
curl -v -X GET https://sandbox.bluesnap.com/services/2/cp/user/23645623?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.
{
"userId": "1111001",
"firstName": "New",
"lastName": "User",
"email": "[email protected]",
"username": "finance 1234",
"allowViewFinancialInfo": true
}
Example Descriptions
For details about the above examples, see:
Retrieve User
This example shows a Retrieve User request. The response returns the userId, firstName, lastName, email, and username values, as well as the allowViewFinancialInfo permission, which indicates that this user only has that permission set.
See User Permissions for a complete list of permissions.
Retrieve User on behalf of linked BlueSnap account
This example shows a Retrieve User request on behalf of a linked BlueSnap account.
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. |