Dealer / Sub-Dealer User Listing & Retrieving Details

Endpoint

• List all users: GET /vendor/users
• Get single user details: GET /vendor/users/{userCode}

HTTP Method: GET Request Content-Type: application/json Response Content-Type: application/json Authorization: Valid AccessToken is required. (See: 2. Authentication – Obtaining AccessToken)

Description

This service is used to list all dealer and sub-dealer users in the system or to view the details of a single user.

Filter parameters can be used to target a specific dealer or user group.

Note

• To get a single user detail, the userCode route parameter must be used.
• If no parameter is provided, the system returns all users in a paginated manner.

Header Information

Header	Required	Description
Authorization	Yes	Valid token in Bearer {AccessToken} format
Content-Type	Yes	application/json

Route Parameter – Single Record Retrieval

Parameter	Type	Required	Description
userCode	string	Yes	Code of the user whose details are requested

Query Parameters – Filtering / Listing

Parameter	Type	Required	Description
DealerCode	string	No	If provided, only users of the specified dealer are listed.
isActive	boolean	No	Filter by active/inactive users.
isAdmin	boolean	No	Filter by admin users.
page	integer	No	Page number (default: 1).
pageSize	integer	No	Number of records per page (default: 20, max: 100).

Example Request – Listing GET /vendor/users?dealerCode=MD001&isActive=true&page=1&pageSize=10

Example Request – Single Record GET /vendor/users/USR1001

Successful Response (200 OK)

{  
  "status": "success",  
  "totalCount": 2,  
  "data": [  
    {  
      "dealerCode": "MD001",  
      "userCode": "USR1001",  
      "memberId": "fbb9d6c7-5e1e-4a5f-b9d4-ccfabc123456",  
      "name": "John",  
      "surname": "Doe",  
      "email": "[email protected]",  
      "gsm": "+905000000000",  
      "isActive": true,  
      "sendRegisterMail": false,  
      "tckn": "00000000000",  
      "isAdmin": false,  
      "isMobileActive": true,  
      "ruleName": ["ROLE_USER"]  
    },  
    {  
      "dealerCode": "MD001",  
      "userCode": "USR1002",  
      "memberId": "6d3e2410-9a78-4b89-bb9d-b91ff671ab45",  
      "name": "John",  
      "surname": "Doe",  
      "email": "[email protected]",  
      "gsm": "+905000000000",  
      "isActive": true,  
      "sendRegisterMail": true,  
      "tckn": "00000000000",  
      "isAdmin": true,  
      "isMobileActive": false,  
      "ruleName": ["ROLE_ADMIN"]  
    }  
  ]  
}

Note: For a single user request (GET /vendor/dealerusers/{userCode}), a single user object may be returned instead of the data array.

Notes & Best Practices

• If the dealerCode parameter is provided, only users belonging to that dealer/sub-dealer are returned.
• Filters like isActive and isAdmin can be used together.
• If pagination parameters are not provided, the system defaults to page=1, pageSize=20.
• Pagination parameters are ignored for single user requests ({userCode}).
• If the token has expired, the request returns 401 Unauthorized; a new token must be obtained.
• For structures with a large number of users, lazy loading or page-based requests is recommended.