Get merchant users

import requests
url = "https://api-sandbox.koywe.com/api/v1/organizations/org_abc123/merchants/mrc_def456/users"
querystring = {"page":"1","limit":"10","name":"John","email":"john@doe.com"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "users": [
    {
      "id": "k3u_abc123",
      "name": "John Doe",
      "email": "john@example.com",
      "isActive": true,
      "lastModifiedRole": "2024-01-20T14:45:00Z",
      "roles": [
        {
          "id": "k3r_user_security_admin",
          "name": "User Security Admin",
          "assignedAt": "2024-01-15T10:30:00Z",
          "lastModified": "2024-01-20T14:45:00Z",
          "description": "Can manage security settings"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "totalPages": 5,
    "totalItems": 50
  }
}

Retrieve a paginated list of users for a specific merchant. Requires ORGANIZATION_SETTINGS_VIEW_MERCHANT permission.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization identifier

merchantIdstringRequired

Merchant identifier

Query parameters

pagedoubleRequired>=1

Page number

limitdoubleRequired1-100

Number of items per page

namestringOptional

Filter by user name (partial match, case-insensitive).

emailstringOptional

Filter by user email (partial match, case-insensitive).

Response

List of merchant users retrieved successfully

userslist of objects

List of users

paginationobject

Pagination information

Errors

400

Get Merchant Users Request Bad Request Error

401

Get Merchant Users Request Unauthorized Error

403

Get Merchant Users Request Forbidden Error

404

Get Merchant Users Request Not Found Error