Account

GET /Account/:entityId

Get Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}

POST /Account

Create Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}

PUT /Account/:entityId

Edit Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}

GET /Account

Get list of Accounts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "type": "string",
            "industry": "string",
            "sicCode": "string",
            "billingAddressStreet": "string",
            "billingAddressCity": "string",
            "billingAddressState": "string",
            "billingAddressCountry": "string",
            "billingAddressPostalCode": "string",
            "shippingAddressStreet": "string",
            "shippingAddressCity": "string",
            "shippingAddressState": "string",
            "shippingAddressCountry": "string",
            "shippingAddressPostalCode": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "ownerUserId": "string"
        }
    ]
}

GET /Account/:entityId/:link

Get linked entities for Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Account/:entityId

Delete Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Account/action/massUpdate

Mass update of Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Account/action/massDelete

Mass delete of Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Account/:entityId/:link

Create link for Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Account/:entityId/:link

Remove link from Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Account/:entityId/subscription

Follow the Account stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Account/:entityId/subscription

Unfollow the Account stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Account/action/merge

Merge Accounts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Account/action/getDuplicateAttributes

Get duplicate attributes from Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}

POST /Account/action/massFollow

Mass follow to Account entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Account/action/massFollow

Mass unfollow from Account entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Asset

GET /Asset/:entityId

Get Asset data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "metaData": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Asset

Create Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "metaData": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "metaData": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /Asset/:entityId

Edit Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "metaData": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "metaData": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Asset

Get list of Assets
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "height": "int",
            "width": "int",
            "colorSpace": "string",
            "colorDepth": "string",
            "orientation": "string",
            "isActive": "bool",
            "libraryId": "string",
            "path": "string",
            "name": "string",
            "description": "string",
            "metaData": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "private": "bool",
            "type": "string",
            "sizeUnit": "string",
            "ownerUserId": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /Asset/:entityId/:link

Get linked entities for Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Asset/:entityId

Delete Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Asset/action/massUpdate

Mass update of Asset data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Asset/action/massDelete

Mass delete of Asset data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Asset/:entityId/:link

Create link for Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Asset/:entityId/:link

Remove link from Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Asset/:entityId/subscription

Follow the Asset stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Asset/:entityId/subscription

Unfollow the Asset stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Asset/action/merge

Merge Assets
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Asset/action/getDuplicateAttributes

Get duplicate attributes from Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "metaData": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Asset/action/massFollow

Mass follow to Asset entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Asset/action/massFollow

Mass unfollow from Asset entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AssetCategory

GET /AssetCategory/:entityId

Get AssetCategory data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}

POST /AssetCategory

Create AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}

PUT /AssetCategory/:entityId

Edit AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}

GET /AssetCategory

Get list of AssetCategorys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "categoryRoute": "string",
            "categoryRouteName": "string",
            "name": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "code": "string",
            "isActive": "bool",
            "hasChild": "bool",
            "categoryParentId": "string",
            "ownerUserId": "string"
        }
    ]
}

GET /AssetCategory/:entityId/:link

Get linked entities for AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /AssetCategory/:entityId

Delete AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /AssetCategory/action/massUpdate

Mass update of AssetCategory data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssetCategory/action/massDelete

Mass delete of AssetCategory data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssetCategory/:entityId/:link

Create link for AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AssetCategory/:entityId/:link

Remove link from AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /AssetCategory/:entityId/subscription

Follow the AssetCategory stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AssetCategory/:entityId/subscription

Unfollow the AssetCategory stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AssetCategory/action/merge

Merge AssetCategorys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AssetCategory/action/getDuplicateAttributes

Get duplicate attributes from AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}

POST /AssetCategory/action/massFollow

Mass follow to AssetCategory entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AssetCategory/action/massFollow

Mass unfollow from AssetCategory entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AssetMetaData

GET /AssetMetaData

Get list of AssetMetaDatas
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "value": "string",
            "assetId": "string",
            "ownerUserId": "string"
        }
    ]
}

GET /AssetMetaData/:entityId

Get AssetMetaData data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}

POST /AssetMetaData

Create AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}

PUT /AssetMetaData/:entityId

Edit AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}

GET /AssetMetaData/:entityId/:link

Get linked entities for AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /AssetMetaData/:entityId

Delete AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /AssetMetaData/action/massUpdate

Mass update of AssetMetaData data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssetMetaData/action/massDelete

Mass delete of AssetMetaData data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssetMetaData/:entityId/:link

Create link for AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AssetMetaData/:entityId/:link

Remove link from AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /AssetMetaData/:entityId/subscription

Follow the AssetMetaData stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AssetMetaData/:entityId/subscription

Unfollow the AssetMetaData stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AssetMetaData/action/merge

Merge AssetMetaDatas
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AssetMetaData/action/getDuplicateAttributes

Get duplicate attributes from AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}

POST /AssetMetaData/action/massFollow

Mass follow to AssetMetaData entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AssetMetaData/action/massFollow

Mass unfollow from AssetMetaData entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AssetType

POST /AssetType

Create AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}

PUT /AssetType/:entityId

Edit AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}

DELETE /AssetType/:entityId

Delete AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /AssetType/action/massUpdate

Mass update of AssetType data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssetType/action/massDelete

Mass delete of AssetType data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssetType/:entityId/:link

Create link for AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AssetType/:entityId/:link

Remove link from AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

GET /AssetType/:entityId

Get AssetType data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}

GET /AssetType

Get list of AssetTypes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string"
        }
    ]
}

GET /AssetType/:entityId/:link

Get linked entities for AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

PUT /AssetType/:entityId/subscription

Follow the AssetType stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AssetType/:entityId/subscription

Unfollow the AssetType stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AssetType/action/merge

Merge AssetTypes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AssetType/action/getDuplicateAttributes

Get duplicate attributes from AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}

POST /AssetType/action/massFollow

Mass follow to AssetType entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AssetType/action/massFollow

Mass unfollow from AssetType entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AssociatedProduct

GET /AssociatedProduct/:entityId

Get AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}

POST /AssociatedProduct

Create AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}

PUT /AssociatedProduct/:entityId

Edit AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}

GET /AssociatedProduct

Get list of AssociatedProducts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "associationId": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "mainProductId": "string",
            "relatedProductId": "string",
            "bothDirections": "bool",
            "backwardAssociationId": "string"
        }
    ]
}

GET /AssociatedProduct/:entityId/:link

Get linked entities for AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /AssociatedProduct/:entityId

Delete AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /AssociatedProduct/action/massUpdate

Mass update of AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssociatedProduct/action/massDelete

Mass delete of AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AssociatedProduct/:entityId/:link

Create link for AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AssociatedProduct/:entityId/:link

Remove link from AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /AssociatedProduct/:entityId/subscription

Follow the AssociatedProduct stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AssociatedProduct/:entityId/subscription

Unfollow the AssociatedProduct stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AssociatedProduct/action/merge

Merge AssociatedProducts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AssociatedProduct/action/getDuplicateAttributes

Get duplicate attributes from AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}

POST /AssociatedProduct/action/massFollow

Mass follow to AssociatedProduct entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AssociatedProduct/action/massFollow

Mass unfollow from AssociatedProduct entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Association

GET /Association/:entityId

Get Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Association

Create Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /Association/:entityId

Edit Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Association

Get list of Associations
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "code": "string",
            "description": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "backwardAssociationId": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /Association/:entityId/:link

Get linked entities for Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Association/:entityId

Delete Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Association/action/massUpdate

Mass update of Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Association/action/massDelete

Mass delete of Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Association/:entityId/:link

Create link for Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Association/:entityId/:link

Remove link from Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Association/:entityId/subscription

Follow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Association/:entityId/subscription

Unfollow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Association/action/merge

Merge Associations
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Association/action/getDuplicateAttributes

Get duplicate attributes from Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Association/action/massFollow

Mass follow to Association entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Association/action/massFollow

Mass unfollow from Association entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Attachment

GET /Attachment/:entityId

Get Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}

POST /Attachment

Create Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}

PUT /Attachment/:entityId

Edit Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}

GET /Attachment

Get list of Attachments
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "type": "string",
            "size": "float",
            "sourceId": "string",
            "field": "string",
            "createdById": "string",
            "role": "string",
            "storage": "string",
            "storageFilePath": "string",
            "storageThumbPath": "string",
            "global": "bool",
            "md5": "string"
        }
    ]
}

GET /Attachment/:entityId/:link

Get linked entities for Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Attachment/:entityId

Delete Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Attachment/action/massUpdate

Mass update of Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Attachment/action/massDelete

Mass delete of Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Attachment/:entityId/:link

Create link for Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Attachment/:entityId/:link

Remove link from Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Attachment/:entityId/subscription

Follow the Attachment stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Attachment/:entityId/subscription

Unfollow the Attachment stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Attachment/action/merge

Merge Attachments
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Attachment/action/getDuplicateAttributes

Get duplicate attributes from Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}

POST /Attachment/action/massFollow

Mass follow to Attachment entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Attachment/action/massFollow

Mass unfollow from Attachment entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Attribute

GET /Markets/Attribute/filtersData

Get filters data for product entity
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"json"

GET /Attribute/:entityId

Get Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}

POST /Attribute

Create Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}

PUT /Attribute/:entityId

Edit Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}

GET /Attribute

Get list of Attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "attributeGroupId": "string",
            "code": "string",
            "type": "string",
            "assetType": "string",
            "isMultilang": "bool",
            "typeValue": "array",
            "isSystem": "bool",
            "sortOrder": "int",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "ownerUserDeDeId": "string",
            "ownerUserEnUsId": "string",
            "assignedUserDeDeId": "string",
            "assignedUserEnUsId": "string",
            "typeValueDeDe": "array",
            "typeValueEnUs": "array"
        }
    ]
}

GET /Attribute/:entityId/:link

Get linked entities for Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Attribute/:entityId

Delete Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Attribute/action/massUpdate

Mass update of Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Attribute/action/massDelete

Mass delete of Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Attribute/:entityId/:link

Create link for Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Attribute/:entityId/:link

Remove link from Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Attribute/:entityId/subscription

Follow the Attribute stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Attribute/:entityId/subscription

Unfollow the Attribute stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Attribute/action/merge

Merge Attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Attribute/action/getDuplicateAttributes

Get duplicate attributes from Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}

POST /Attribute/action/massFollow

Mass follow to Attribute entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Attribute/action/massFollow

Mass unfollow from Attribute entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AttributeGroup

GET /AttributeGroup/:entityId

Get AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /AttributeGroup

Create AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /AttributeGroup/:entityId

Edit AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /AttributeGroup

Get list of AttributeGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "code": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "sortOrder": "int",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /AttributeGroup/:entityId/:link

Get linked entities for AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /AttributeGroup/:entityId

Delete AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /AttributeGroup/action/massUpdate

Mass update of AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AttributeGroup/action/massDelete

Mass delete of AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AttributeGroup/:entityId/:link

Create link for AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AttributeGroup/:entityId/:link

Remove link from AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /AttributeGroup/:entityId/subscription

Follow the AttributeGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AttributeGroup/:entityId/subscription

Unfollow the AttributeGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AttributeGroup/action/merge

Merge AttributeGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AttributeGroup/action/getDuplicateAttributes

Get duplicate attributes from AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /AttributeGroup/action/massFollow

Mass follow to AttributeGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AttributeGroup/action/massFollow

Mass unfollow from AttributeGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AuthLogRecord

PUT /AuthLogRecord/:entityId

Edit AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}

PUT /AuthLogRecord/action/massUpdate

Mass update of AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AuthLogRecord

Create AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}

POST /AuthLogRecord/:entityId/:link

Create link for AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AuthLogRecord/:entityId/:link

Remove link from AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

GET /AuthLogRecord/:entityId

Get AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}

GET /AuthLogRecord

Get list of AuthLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "username": "string",
            "portalId": "string",
            "userId": "string",
            "authTokenId": "string",
            "ipAddress": "string",
            "isDenied": "bool",
            "denialReason": "string",
            "requestTime": "float",
            "requestUrl": "string",
            "requestMethod": "string"
        }
    ]
}

GET /AuthLogRecord/:entityId/:link

Get linked entities for AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /AuthLogRecord/:entityId

Delete AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

POST /AuthLogRecord/action/massDelete

Mass delete of AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

PUT /AuthLogRecord/:entityId/subscription

Follow the AuthLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AuthLogRecord/:entityId/subscription

Unfollow the AuthLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AuthLogRecord/action/merge

Merge AuthLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AuthLogRecord/action/getDuplicateAttributes

Get duplicate attributes from AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}

POST /AuthLogRecord/action/massFollow

Mass follow to AuthLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AuthLogRecord/action/massFollow

Mass unfollow from AuthLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

AuthToken

PUT /AuthToken/:entityId

Edit AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool"
}

PUT /AuthToken/action/massUpdate

Mass update of AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /AuthToken

Create AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool"
}

POST /AuthToken/:entityId/:link

Create link for AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /AuthToken/:entityId/:link

Remove link from AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

GET /AuthToken/:entityId

Get AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool"
}

GET /AuthToken

Get list of AuthTokens
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "token": "string",
            "hash": "string",
            "userId": "string",
            "portalId": "string",
            "ipAddress": "string",
            "isActive": "bool"
        }
    ]
}

GET /AuthToken/:entityId/:link

Get linked entities for AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /AuthToken/:entityId

Delete AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

POST /AuthToken/action/massDelete

Mass delete of AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

PUT /AuthToken/:entityId/subscription

Follow the AuthToken stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /AuthToken/:entityId/subscription

Unfollow the AuthToken stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /AuthToken/action/merge

Merge AuthTokens
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /AuthToken/action/getDuplicateAttributes

Get duplicate attributes from AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool"
}

POST /AuthToken/action/massFollow

Mass follow to AuthToken entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /AuthToken/action/massFollow

Mass unfollow from AuthToken entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Brand

GET /Brand/:entityId

Get Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Brand

Create Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /Brand/:entityId

Edit Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Brand

Get list of Brands
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "code": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /Brand/:entityId/:link

Get linked entities for Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Brand/:entityId

Delete Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Brand/action/massUpdate

Mass update of Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Brand/action/massDelete

Mass delete of Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Brand/:entityId/:link

Create link for Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Brand/:entityId/:link

Remove link from Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Brand/:entityId/subscription

Follow the Brand stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Brand/:entityId/subscription

Unfollow the Brand stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Brand/action/merge

Merge Brands
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Brand/action/getDuplicateAttributes

Get duplicate attributes from Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Brand/action/massFollow

Mass follow to Brand entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Brand/action/massFollow

Mass unfollow from Brand entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Catalog

GET /Catalog/:entityId

Get Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Catalog

Create Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /Catalog/:entityId

Edit Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Catalog

Get list of Catalogs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "code": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "isActive": "bool",
            "ownerUserId": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /Catalog/:entityId/:link

Get linked entities for Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Catalog/:entityId

Delete Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Catalog/action/massUpdate

Mass update of Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Catalog/action/massDelete

Mass delete of Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Catalog/:entityId/:link

Create link for Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Catalog/:entityId/:link

Remove link from Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Catalog/:entityId/subscription

Follow the Catalog stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Catalog/:entityId/subscription

Unfollow the Catalog stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Catalog/action/merge

Merge Catalogs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Catalog/action/getDuplicateAttributes

Get duplicate attributes from Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Catalog/action/massFollow

Mass follow to Catalog entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Catalog/action/massFollow

Mass unfollow from Catalog entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Category

GET /Category/:entityId

Get Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Category

Create Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /Category/:entityId

Edit Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Category

Get list of Categorys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "code": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "sortOrder": "int",
            "categoryParentId": "string",
            "categoryRoute": "string",
            "categoryRouteName": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /Category/:entityId/:link

Get linked entities for Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Category/:entityId

Delete Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Category/action/massUpdate

Mass update of Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Category/action/massDelete

Mass delete of Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Category/:entityId/:link

Create link for Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Category/:entityId/:link

Remove link from Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Category/:entityId/subscription

Follow the Category stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Category/:entityId/subscription

Unfollow the Category stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Category/action/merge

Merge Categorys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Category/action/getDuplicateAttributes

Get duplicate attributes from Category
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Category/action/massFollow

Mass follow to Category entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Category/action/massFollow

Mass unfollow from Category entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Channel

GET /Markets/Channel/{channel_id}/Product/{product_id}/attributes

Get channel product attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
channel_id string Channel id Yes
product_id string Product id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
[
    {
        "productAttributeValueId": "string",
        "attributeId": "string",
        "name": "string",
        "type": "string",
        "isRequired": "bool",
        "typeValue": [
            "string",
            "string",
            "..."
        ],
        "typeValueEnUs": [
            "string",
            "string",
            "..."
        ],
        "typeValue other languages ...": [],
        "value": "array|string",
        "valueEnUs": "array|string",
        "value other languages ...": "array|string",
        "attributeGroupId": "string",
        "attributeGroupName": "string",
        "attributeGroupOrder": "int",
        "isCustom": "bool"
    }
]

GET /Markets/Channel/{channel_id}/products

Get products in channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
channel_id string Channel id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
[
    {
        "channelProductId": "string",
        "productId": "string",
        "productName": "string",
        "categories": [
            "string - categories name"
        ],
        "isActive": "bool",
        "isEditable": "bool"
    },
    "..."
]

GET /Channel/:entityId

Get Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Channel

Create Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

PUT /Channel/:entityId

Edit Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Channel

Get list of Channels
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "code": "string",
            "categoryId": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}

GET /Channel/:entityId/:link

Get linked entities for Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Channel/:entityId

Delete Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Channel/action/massUpdate

Mass update of Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Channel/action/massDelete

Mass delete of Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Channel/:entityId/:link

Create link for Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Channel/:entityId/:link

Remove link from Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Channel/:entityId/subscription

Follow the Channel stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Channel/:entityId/subscription

Unfollow the Channel stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Channel/action/merge

Merge Channels
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Channel/action/getDuplicateAttributes

Get duplicate attributes from Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Channel/action/massFollow

Mass follow to Channel entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Channel/action/massFollow

Mass unfollow from Channel entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Composer

POST /Composer/runUpdate

Call composer update command
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Composer/cancelUpdate

Cancel changes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

GET /ModuleManager/list

Get modules
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": 1,
    "list": [
        {
            "id": "Revisions",
            "name": "Revisions",
            "version": "1.0.0",
            "description": "Module Revisions.",
            "required": [],
            "isActive": true
        }
    ]
}

POST /ModuleManager/installModule

Install module
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
null
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

PUT /ModuleManager/updateModule

Update module version
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "Erp",
    "version": "1.1.0"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /ModuleManager/deleteModule

Delete module
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "Erp"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /ModuleManager/cancel

Cancel module changes
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "Erp"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

GET /ModuleManager/logs

Get composer stream data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": "array"
}

Contact

GET /Contact/:entityId

Get Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}

POST /Contact

Create Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}

PUT /Contact/:entityId

Edit Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}

GET /Contact

Get list of Contacts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "salutationName": "string",
            "firstName": "string",
            "lastName": "string",
            "accountId": "string",
            "description": "string",
            "doNotCall": "bool",
            "addressStreet": "string",
            "addressCity": "string",
            "addressState": "string",
            "addressCountry": "string",
            "addressPostalCode": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string"
        }
    ]
}

GET /Contact/:entityId/:link

Get linked entities for Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Contact/:entityId

Delete Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Contact/action/massUpdate

Mass update of Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Contact/action/massDelete

Mass delete of Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Contact/:entityId/:link

Create link for Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Contact/:entityId/:link

Remove link from Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Contact/:entityId/subscription

Follow the Contact stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Contact/:entityId/subscription

Unfollow the Contact stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Contact/action/merge

Merge Contacts
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Contact/action/getDuplicateAttributes

Get duplicate attributes from Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}

POST /Contact/action/massFollow

Mass follow to Contact entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Contact/action/massFollow

Mass unfollow from Contact entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Content

GET /Content/:entityId

Get Content data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

POST /Content

Create Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

PUT /Content/:entityId

Edit Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

GET /Content

Get list of Contents
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "status": "string",
            "type": "string",
            "description": "string",
            "text": "string",
            "metaTitle": "string",
            "metaDescription": "string",
            "contentGroupId": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string"
        }
    ]
}

GET /Content/:entityId/:link

Get linked entities for Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Content/:entityId

Delete Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Content/action/massUpdate

Mass update of Content data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Content/action/massDelete

Mass delete of Content data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Content/:entityId/:link

Create link for Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Content/:entityId/:link

Remove link from Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Content/:entityId/subscription

Follow the Content stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Content/:entityId/subscription

Unfollow the Content stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Content/action/merge

Merge Contents
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Content/action/getDuplicateAttributes

Get duplicate attributes from Content
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

POST /Content/action/massFollow

Mass follow to Content entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Content/action/massFollow

Mass unfollow from Content entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

ContentGroup

GET /ContentGroup/:entityId

Get ContentGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

POST /ContentGroup

Create ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

PUT /ContentGroup/:entityId

Edit ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

GET /ContentGroup

Get list of ContentGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string"
        }
    ]
}

GET /ContentGroup/:entityId/:link

Get linked entities for ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /ContentGroup/:entityId

Delete ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /ContentGroup/action/massUpdate

Mass update of ContentGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /ContentGroup/action/massDelete

Mass delete of ContentGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /ContentGroup/:entityId/:link

Create link for ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /ContentGroup/:entityId/:link

Remove link from ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /ContentGroup/:entityId/subscription

Follow the ContentGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /ContentGroup/:entityId/subscription

Unfollow the ContentGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /ContentGroup/action/merge

Merge ContentGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /ContentGroup/action/getDuplicateAttributes

Get duplicate attributes from ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

POST /ContentGroup/action/massFollow

Mass follow to ContentGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /ContentGroup/action/massFollow

Mass unfollow from ContentGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Country

GET /Country/:entityId

Get Country data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "nameDeDe": "string",
    "nameEnUs": "string"
}

POST /Country

Create Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "nameDeDe": "string",
    "nameEnUs": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "nameDeDe": "string",
    "nameEnUs": "string"
}

PUT /Country/:entityId

Edit Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "nameDeDe": "string",
    "nameEnUs": "string"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "nameDeDe": "string",
    "nameEnUs": "string"
}

GET /Country

Get list of Countrys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "isActive": "bool",
            "nameDeDe": "string",
            "nameEnUs": "string"
        }
    ]
}

GET /Country/:entityId/:link

Get linked entities for Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /Country/:entityId

Delete Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /Country/action/massUpdate

Mass update of Country data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Country/action/massDelete

Mass delete of Country data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /Country/:entityId/:link

Create link for Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /Country/:entityId/:link

Remove link from Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /Country/:entityId/subscription

Follow the Country stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /Country/:entityId/subscription

Unfollow the Country stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /Country/action/merge

Merge Countrys
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /Country/action/getDuplicateAttributes

Get duplicate attributes from Country
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "nameDeDe": "string",
    "nameEnUs": "string"
}

POST /Country/action/massFollow

Mass follow to Country entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /Country/action/massFollow

Mass unfollow from Country entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

DamConfig

GET /DamConfig/:entityId

Get DamConfig data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
[]

POST /DamConfig

Create DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
[]
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
[]

PUT /DamConfig/:entityId

Edit DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
[]
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
[]

GET /DamConfig

Get list of DamConfigs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "int",
    "list": [
        []
    ]
}

GET /DamConfig/:entityId/:link

Get linked entities for DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "total": "integer",
    "list": "array"
}

DELETE /DamConfig/:entityId

Delete DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
true

PUT /DamConfig/action/massUpdate

Mass update of DamConfig data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /DamConfig/action/massDelete

Mass delete of DamConfig data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "count": "integer",
    "ids": "array"
}

POST /DamConfig/:entityId/:link

Create link for DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

DELETE /DamConfig/:entityId/:link

Remove link from DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

PUT /DamConfig/:entityId/subscription

Follow the DamConfig stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

DELETE /DamConfig/:entityId/subscription

Unfollow the DamConfig stream
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
"bool"

POST /DamConfig/action/merge

Merge DamConfigs
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
"bool"

POST /DamConfig/action/getDuplicateAttributes

Get duplicate attributes from DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "id": "string"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
[]

POST /DamConfig/action/massFollow

Mass follow to DamConfig entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

POST /DamConfig/action/massFollow

Mass unfollow from DamConfig entities
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "ids": "array",
    "count": "integer"
}

Dashlet

GET /Dashlet/{dashletName}

Get Dashlet data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
dashletName string Dashlet name Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
[
    {
        "total": "integer",
        "list": "array"
    }
]

Email

GET /Email/:entityId

Get Email data
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "fromName": "string",
    "fromString": "string",
    "replyToString": "string",
    "addressNameMap": "json",
    "isReplied": "bool",
    "messageId": "string",
    "messageIdInternal": "string",
    "fromEmailAddressId": "string",
    "bodyPlain": "string",
    "body": "string",
    "isHtml": "bool",
    "status": "string",
    "hasAttachment": "bool",
    "createdById": "string",
    "sentById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "repliedId": "string",
    "isSystem": "bool"
}

POST /Email

Create Email
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{
    "name": "string",
    "fromName": "string",
    "fromString": "string",
    "replyToString": "string",
    "addressNameMap": "json",
    "isReplied": "bool",
    "messageId": "string",
    "messageIdInternal": "string",
    "fromEmailAddressId": "string",
    "bodyPlain": "string",
    "body": "string",
    "isHtml": "bool",
    "status": "string",
    "hasAttachment": "bool",
    "createdById": "string",
    "sentById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "repliedId": "string",
    "isSystem": "bool"
}
Status Codes 
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
Body 
{
    "name": "string",
    "fromName": "string",
    "fromString": "string",
    "replyToString": "string",
    "addressNameMap": "json",
    "isReplied": "bool",
    "messageId": "string",
    "messageIdInternal": "string",
    "fromEmailAddressId": "string",
    "bodyPlain": "string",
    "body": "string",
    "isHtml": "bool",
    "status": "string",
    "hasAttachment": "bool",
    "createdById": "string",
    "sentById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "repliedId": "string",
    "isSystem": "bool"
}

PUT /Email/:entityId

Edit Email
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "fromName": "string",
    "fromString": "string",
    "replyToString": "string",
    "addressNameMap": "json",
    "isReplied": "bool",
    "messageId": "string",
    "messageIdInternal": "string",
    "fromEmailAddressId": "string",
    "bodyPlain": "string",
    "body": "string",
    "isHtml": "bool",
    "status": "string",
    "hasAttachment": "bool",
    "createdById": "string",
    "sentById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "repliedId": "string",
    "isSystem": "bool"
}
Status Codes 
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Body 
{
    "name": "string",
    "fromName": "string",
    "fromString": "string",
    "replyToString": "string",
    "addressNameMap": "json",
    "isReplied": "bool",
    "messageId": "string",
    "messageIdInternal": "string",
    "fromEmailAddressId": "string",
    "bodyPlain": "string",
    "body": "string",
    "isHtml": "bool",
    "status": "string",
    "hasAttachment": "bool",
    "createdById": "string",
    "sentById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "repliedId": "string",
    "isSystem": "bool"
}

GET /Email