Skip to Content
DocumentationAPI ReferenceBusiness APIEndpointsEnterprise Business Management Api

EnterpriseBusinessManagementApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
activateEnterpriseUserPOST /enterprises/{enterprise_id}/users/{user_id}/activateActivate an enterprise user
createEnterpriseDomainPOST /enterprises/{enterprise_id}/domainsCreate enterprise domain
createEnterpriseRolePOST /enterprises/{enterprise_id}/rolesCreate enterprise role
createEnterpriseWebhookPOST /enterprises/{enterprise_id}/webhooksCreate enterprise webhook
deleteEnterpriseDomainDELETE /enterprises/{enterprise_id}/domains/{domain_id}Delete enterprise domain
deleteEnterpriseRoleDELETE /enterprises/{enterprise_id}/roles/{role_id}Delete enterprise role
deleteEnterpriseUserDELETE /enterprises/{enterprise_id}/users/{user_id}Delete an enterprise user
deleteEnterpriseWebhookDELETE /enterprises/{enterprise_id}/webhooks/{webhook_id}Delete enterprise webhook
getDomainVerificationStatusGET /enterprises/{enterprise_id}/domains/{domain_id}/verificationGet domain verification status
getEnterpriseDomainGET /enterprises/{enterprise_id}/domains/{domain_id}Get domain by ID
getEnterpriseRoleGET /enterprises/{enterprise_id}/roles/{role_id}Get role by ID
getEnterpriseUserGET /enterprises/{enterprise_id}/users/{user_id}Get a specific enterprise user by ID
getEnterpriseWebhookGET /enterprises/{enterprise_id}/webhooks/{webhook_id}Get webhook by ID
listEnterpriseDomainsGET /enterprises/{enterprise_id}/domainsList enterprise domains
listEnterpriseRolesGET /enterprises/{enterprise_id}/rolesList enterprise roles
listEnterpriseUsersGET /enterprises/{enterprise_id}/usersList all users in an enterprise
listEnterpriseWebhooksGET /enterprises/{enterprise_id}/webhooksList enterprise webhooks
resetEnterpriseUserPasswordPOST /enterprises/{enterprise_id}/users/{user_id}/reset-passwordReset an enterprise user’s password
suspendEnterpriseUserPOST /enterprises/{enterprise_id}/users/{user_id}/suspendSuspend an enterprise user
testEnterpriseWebhookPOST /enterprises/{enterprise_id}/webhooks/{webhook_id}/testTest webhook endpoint
updateEnterpriseDomainPUT /enterprises/{enterprise_id}/domains/{domain_id}Update enterprise domain
updateEnterpriseRolePUT /enterprises/{enterprise_id}/roles/{role_id}Update enterprise role
updateEnterpriseUserPUT /enterprises/{enterprise_id}/users/{user_id}Update an enterprise user’s information
updateEnterpriseWebhookPUT /enterprises/{enterprise_id}/webhooks/{webhook_id}Update enterprise webhook
verifyEnterpriseDomainPOST /enterprises/{enterprise_id}/domains/{domain_id}/verifyVerify domain ownership

activateEnterpriseUser

EnterpriseUserResponse activateEnterpriseUser(enterprise_id, user_id)

Activate an enterprise user

Reactivates a previously suspended user, restoring their access to the enterprise.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
user_idLongThe ID of the user to activate[default to null]

Return type

EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

createEnterpriseDomain

EnterpriseDomainResponse createEnterpriseDomain(enterprise_id, AddEnterpriseDomainRequest)

Create enterprise domain

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
AddEnterpriseDomainRequestAddEnterpriseDomainRequest

Return type

EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseRole

EnterpriseRoleResponse createEnterpriseRole(enterprise_id, CreateEnterpriseRoleRequest)

Create enterprise role

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
CreateEnterpriseRoleRequestCreateEnterpriseRoleRequest

Return type

EnterpriseRoleResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

createEnterpriseWebhook

EnterpriseWebhookResponse createEnterpriseWebhook(enterprise_id, CreateEnterpriseWebhookRequest)

Create enterprise webhook

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
CreateEnterpriseWebhookRequestCreateEnterpriseWebhookRequest

Return type

EnterpriseWebhookResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

deleteEnterpriseDomain

DeleteResponse deleteEnterpriseDomain(enterprise_id, domain_id)

Delete enterprise domain

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseRole

DeleteResponse deleteEnterpriseRole(enterprise_id, role_id)

Delete enterprise role

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
role_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseUser

DeleteResponse deleteEnterpriseUser(enterprise_id, user_id)

Delete an enterprise user

Permanently removes a user from the enterprise. This action cannot be undone.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
user_idLongThe ID of the user to delete[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

deleteEnterpriseWebhook

DeleteResponse deleteEnterpriseWebhook(enterprise_id, webhook_id)

Delete enterprise webhook

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
webhook_idLong[default to null]

Return type

DeleteResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getDomainVerificationStatus

DomainVerificationStatusResponse getDomainVerificationStatus(enterprise_id, domain_id)

Get domain verification status

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

DomainVerificationStatusResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseDomain

EnterpriseDomainResponse getEnterpriseDomain(enterprise_id, domain_id)

Get domain by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseRole

EnterpriseRoleResponse getEnterpriseRole(enterprise_id, role_id)

Get role by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
role_idLong[default to null]

Return type

EnterpriseRoleResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseUser

EnterpriseUserResponse getEnterpriseUser(enterprise_id, user_id)

Get a specific enterprise user by ID

Retrieves detailed information about a single user within an enterprise.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
user_idLongThe ID of the user to retrieve[default to null]

Return type

EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getEnterpriseWebhook

EnterpriseWebhookResponse getEnterpriseWebhook(enterprise_id, webhook_id)

Get webhook by ID

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
webhook_idLong[default to null]

Return type

EnterpriseWebhookResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseDomains

PaginatedResponse_EnterpriseDomainResponse listEnterpriseDomains(enterprise_id, page, per_page, verified)

List enterprise domains

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageLong[optional] [default to null]
per_pageLong[optional] [default to null]
verifiedBoolean[optional] [default to null]

Return type

PaginatedResponse_EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseRoles

PaginatedResponse_EnterpriseRoleResponse listEnterpriseRoles(enterprise_id, page, per_page, search)

List enterprise roles

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageLong[optional] [default to null]
per_pageLong[optional] [default to null]
searchString[optional] [default to null]

Return type

PaginatedResponse_EnterpriseRoleResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseUsers

PaginatedResponse_EnterpriseUserResponse listEnterpriseUsers(enterprise_id, page, per_page, search, status, role_id)

List all users in an enterprise

Returns a paginated list of users belonging to the specified enterprise. Supports filtering by search query, status, and role.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
pageLongPage number for pagination (default: 1)[optional] [default to null]
per_pageLongNumber of items per page (default: 20)[optional] [default to null]
searchStringOptional search query to filter users by name or email[optional] [default to null]
statusStringOptional status filter (active, suspended, etc.)[optional] [default to null]
role_idLongOptional role ID to filter users by role[optional] [default to null]

Return type

PaginatedResponse_EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

listEnterpriseWebhooks

PaginatedResponse_EnterpriseWebhookResponse listEnterpriseWebhooks(enterprise_id, page, per_page)

List enterprise webhooks

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_EnterpriseWebhookResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

resetEnterpriseUserPassword

PasswordResetResponse resetEnterpriseUserPassword(enterprise_id, user_id)

Reset an enterprise user’s password

Generates and assigns a new temporary password for the user. The temporary password is returned in the response and should be securely communicated to the user.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
user_idLongThe ID of the user whose password should be reset[default to null]

Return type

PasswordResetResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

suspendEnterpriseUser

EnterpriseUserResponse suspendEnterpriseUser(enterprise_id, user_id)

Suspend an enterprise user

Temporarily suspends a user’s access to the enterprise. The user can be reactivated later.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
user_idLongThe ID of the user to suspend[default to null]

Return type

EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

testEnterpriseWebhook

WebhookTestResponse testEnterpriseWebhook(enterprise_id, webhook_id)

Test webhook endpoint

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
webhook_idLong[default to null]

Return type

WebhookTestResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

updateEnterpriseDomain

EnterpriseDomainResponse updateEnterpriseDomain(enterprise_id, domain_id, UpdateEnterpriseDomainRequest)

Update enterprise domain

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]
UpdateEnterpriseDomainRequestUpdateEnterpriseDomainRequest

Return type

EnterpriseDomainResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseRole

EnterpriseRoleResponse updateEnterpriseRole(enterprise_id, role_id, UpdateEnterpriseRoleRequest)

Update enterprise role

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
role_idLong[default to null]
UpdateEnterpriseRoleRequestUpdateEnterpriseRoleRequest

Return type

EnterpriseRoleResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseUser

EnterpriseUserResponse updateEnterpriseUser(enterprise_id, user_id, UpdateEnterpriseUserRequest)

Update an enterprise user’s information

Updates the profile and settings of an existing user within the enterprise. Only the fields provided in the request body will be updated.

Parameters

NameTypeDescriptionNotes
enterprise_idLongThe ID of the enterprise[default to null]
user_idLongThe ID of the user to update[default to null]
UpdateEnterpriseUserRequestUpdateEnterpriseUserRequestThe update request containing the fields to modify

Return type

EnterpriseUserResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

updateEnterpriseWebhook

EnterpriseWebhookResponse updateEnterpriseWebhook(enterprise_id, webhook_id, UpdateEnterpriseWebhookRequest)

Update enterprise webhook

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
webhook_idLong[default to null]
UpdateEnterpriseWebhookRequestUpdateEnterpriseWebhookRequest

Return type

EnterpriseWebhookResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

verifyEnterpriseDomain

DomainVerifyResponse verifyEnterpriseDomain(enterprise_id, domain_id)

Verify domain ownership

Parameters

NameTypeDescriptionNotes
enterprise_idLong[default to null]
domain_idLong[default to null]

Return type

DomainVerifyResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8