VendorUsersApi
All URIs are relative to https://business.apis.kesk.app/v1Â
| Method | HTTP request | Description |
|---|---|---|
| acceptVendorInvitation | POST /vendors/user-management/accept-invitation | Accept vendor invitation and complete user registration |
| assignVendorUserRole | POST /vendors/{vendor_id}/user-management/users/{user_id}/roles/{role_id} | Assign role to a user |
| createVendorRole | POST /vendors/{vendor_id}/user-management/roles | Create a new vendor role |
| deleteVendorRole | DELETE /vendors/{vendor_id}/user-management/roles/{role_id} | Delete a vendor role |
| deleteVendorUser | DELETE /vendors/{vendor_id}/users/{user_id} | Delete a vendor user |
| getVendorPermissions | GET /vendors/{vendor_id}/user-management/permissions | Get available permissions for vendor roles |
| getVendorRole | GET /vendors/{vendor_id}/user-management/roles/{role_id} | Get a specific vendor role |
| getVendorUser | GET /vendors/{vendor_id}/users/{user_id} | Get a specific vendor user |
| inviteVendorUser | POST /vendors/{vendor_id}/users/invite | Send invitation to a user to join vendor |
| listVendorRoles | GET /vendors/{vendor_id}/user-management/roles | List all roles for a vendor |
| listVendorUsers | GET /vendors/{vendor_id}/users | List all users for a vendor |
| removeVendorUserRole | DELETE /vendors/{vendor_id}/user-management/users/{user_id}/roles/{role_id} | Remove role from a user |
| updateVendorRole | PUT /vendors/{vendor_id}/user-management/roles/{role_id} | Update a vendor role |
| updateVendorUser | PUT /vendors/{vendor_id}/users/{user_id} | Update a vendor user |
acceptVendorInvitation
VendorUserResponse acceptVendorInvitation(AcceptVendorInvitationRequest)
Accept vendor invitation and complete user registration
Allows an invited user to accept their invitation and join the vendor’s team. The invitation token is validated and the user is added to the vendor account.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| AcceptVendorInvitationRequest | AcceptVendorInvitationRequest | Request containing the unique invitation token |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
assignVendorUserRole
MessageResponse assignVendorUserRole(vendor_id, user_id, role_id)
Assign role to a user
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| user_id | Long | [default to null] | |
| role_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
createVendorRole
VendorRoleListResponse createVendorRole(vendor_id, CreateVendorRoleRequest)
Create a new vendor role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| CreateVendorRoleRequest | CreateVendorRoleRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteVendorRole
MessageResponse deleteVendorRole(vendor_id, role_id)
Delete a vendor role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| role_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
deleteVendorUser
MessageResponse deleteVendorUser(vendor_id, user_id)
Delete a vendor user
Removes a team member from the vendor’s account. This action permanently revokes the user’s access to vendor resources.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| user_id | Long | Unique identifier of the user to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorPermissions
PaginatedResponse_string getVendorPermissions(vendor_id, page, per_page)
Get available permissions for vendor roles
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorRole
VendorRoleListResponse getVendorRole(vendor_id, role_id)
Get a specific vendor role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| role_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorUser
VendorUserResponse getVendorUser(vendor_id, user_id)
Get a specific vendor user
Retrieves detailed information about a specific team member. Returns user profile, roles, and activity status.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| user_id | Long | Unique identifier of the user to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
inviteVendorUser
VendorInvitationResponse inviteVendorUser(vendor_id, InviteVendorUserRequest)
Send invitation to a user to join vendor
Creates and sends an invitation to a new team member via email or phone. The invitation includes a unique token for completing the registration process.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| InviteVendorUserRequest | InviteVendorUserRequest | Invitation details including email or phone number |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
listVendorRoles
PaginatedResponse_VendorRoleListResponse listVendorRoles(vendor_id, per_page, page, search, is_active)
List all roles for a vendor
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| per_page | Integer | [optional] [default to null] | |
| page | Integer | [optional] [default to null] | |
| search | String | [optional] [default to null] | |
| is_active | Boolean | [optional] [default to null] |
Return type
PaginatedResponse_VendorRoleListResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorUsers
PaginatedResponse_VendorUserResponse listVendorUsers(vendor_id, per_page, page, search, role, is_active)
List all users for a vendor
Retrieves a paginated list of all team members associated with the vendor. Supports filtering by search term, role, and active status.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| per_page | Integer | Number of results per page (default: 10) | [optional] [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| search | String | Search term to filter users by name or email | [optional] [default to null] |
| role | String | Filter users by specific role | [optional] [default to null] |
| is_active | Boolean | Filter users by active status | [optional] [default to null] |
Return type
PaginatedResponse_VendorUserResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
removeVendorUserRole
MessageResponse removeVendorUserRole(vendor_id, user_id, role_id)
Remove role from a user
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| user_id | Long | [default to null] | |
| role_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateVendorRole
VendorRoleListResponse updateVendorRole(vendor_id, role_id, UpdateVendorRoleRequest)
Update a vendor role
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| role_id | Long | [default to null] | |
| UpdateVendorRoleRequest | UpdateVendorRoleRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateVendorUser
VendorUserResponse updateVendorUser(vendor_id, user_id, UpdateVendorUserRequest)
Update a vendor user
Modifies an existing team member’s profile information and settings. Allows updating name, email, phone, and active status.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| user_id | Long | Unique identifier of the user to update | [default to null] |
| UpdateVendorUserRequest | UpdateVendorUserRequest | Updated user information |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8