Merchant

Get merchant users

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

get/api/v1/organizations/{organizationId}/merchants/{merchantId}/users

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/merchants/{merchantId}/users
  • Auth: HTTP bearer

Path parameters

organizationIdstring required
Example:org_abc123

Organization identifier

merchantIdstring required
Example:mrc_def456

Merchant identifier

Query parameters

pagenumber required
Example:1

Page number

limitnumber required
Example:10

Number of items per page

namestring
Example:John

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

emailstring
Example:john@doe.com

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

Response

List of merchant users retrieved successfully

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.