Users

Retrieve user details by email

get

Returns a single user's profile (name, email, status, the accounts/sites they have roles on, and their last login date), looked up by email.

Scoped to the caller's own account and any account manually linked to it (accounts linking) - a user belonging only to an unrelated account will not be found.

Path parameters

EmailstringRequired

The email address of the user to retrieve.

Example: [e-mail]

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

UserNamestringOptionalExample: jonathan.smith

EmailstringOptionalExample: [e-mail]

FirstNamestringOptionalExample: Jonathan

LastNamestringOptionalExample: Smith

UserStatusstring · enumOptional

The user's status.

Example: ENABLEDPossible values:

LastLoginDatestring · nullableOptional

ISO-8601 timestamp of the user's last login. Null if the user has never logged in.

Example: 2026-08-24T12:47:20+00:00

400

Bad request - validation error

application/json

404

Not found

application/json

get/users/{Email}

GET /rest/6.0/users/{Email} HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "UserName": "jonathan.smith",
  "Email": "[e-mail]",
  "FirstName": "Jonathan",
  "LastName": "Smith",
  "UserStatus": "ENABLED",
  "Accounts": [
    {
      "Homepage": "mystore.2checkout.com",
      "Roles": [
        "ADMIN"
      ],
      "Default": true
    }
  ],
  "LastLoginDate": "2026-08-24T12:47:20+00:00"
}

Retrieve users list

get

Returns a paginated list of user profiles (name, email, status, the accounts/sites they have roles on, and their last login date) belonging to the caller's own account and any account manually linked to it (accounts linking).

Takes no parameters beyond pagination - the vendor is derived entirely from the authentication used for the call. This endpoint never returns a 404; an empty result set is returned as a 200 with an empty Data array.

Query parameters

Pageinteger · min: 1Optional

Page number for pagination. Default value is 1. Must be >= 1.

Default: 1Example: 1

Limitinteger · min: 1 · max: 1000Optional

Number of results per page. Default value is 100. Must be between 1 and 1000.

Default: 100Example: 100

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

get/users/

GET /rest/6.0/users/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

200

OK

{
  "Data": [
    {
      "UserName": "jonathan.smith",
      "Email": "[e-mail]",
      "FirstName": "Jonathan",
      "LastName": "Smith",
      "UserStatus": "ENABLED",
      "Accounts": [
        {
          "Homepage": "mystore.2checkout.com",
          "Roles": [
            "ADMIN"
          ],
          "Default": true
        }
      ],
      "LastLoginDate": "2026-08-24T12:47:20+00:00"
    },
    {
      "UserName": "jane.doe",
      "Email": "[e-mail]",
      "FirstName": "Jane",
      "LastName": "Doe",
      "UserStatus": "ENABLED",
      "Accounts": [
        {
          "Homepage": "linkedstore.2checkout.com",
          "Roles": [
            "SUPPORT"
          ],
          "Default": false
        }
      ],
      "LastLoginDate": null
    }
  ],
  "Pagination": {
    "Page": 1,
    "Limit": 10,
    "Count": 2
  }
}