Get organization users

curl -G https://api-sandbox.koywe.com/api/v1/organizations/org_abc123/users \
     -H "Authorization: Bearer <token>" \
     -d page=1 \
     -d limit=10 \
     -d name=John \
     --data-urlencode email=john@doe.com

{
  "users": [
    {
      "id": "k3u_abc123",
      "name": "John Doe",
      "email": "john@example.com",
      "isActive": true,
      "lastModifiedRole": "2024-01-20T14:45:00Z",
      "roles": [
        {
          "id": "k3r_user_org_admin",
          "name": "User & Organization Admin",
          "assignedAt": "2024-01-15T10:30:00Z",
          "lastModified": "2024-01-20T14:45:00Z",
          "description": "Management of users and organizations"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "totalPages": 5,
    "totalItems": 50
  }
}

Retrieve a paginated list of users for a specific organization. Requires ORGANIZATION_SETTINGS_VIEW_USER permission.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

Organization 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 organization users retrieved successfully

userslist of objects

List of users

paginationobject

Pagination information

Errors

400

Get Organization Users Request Bad Request Error

401

Get Organization Users Request Unauthorized Error

403

Get Organization Users Request Forbidden Error

404

Get Organization Users Request Not Found Error