Account

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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}

POST /Account

Create Account
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
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
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}]}
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
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
Export 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
{'id': 'string'}
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'}
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'}
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'
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'
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'
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'
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'
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
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","website":"string","emailAddress":"string","phoneNumber":"string","type":"string","industry":"string","sicCode":"string","contactRole":"string","contactIsInactive":"bool","billingAddress":"string","billingAddressStreet":"string","billingAddressCity":"string","billingAddressState":"string","billingAddressCountry":"string","billingAddressPostalCode":"string","shippingAddress":"string","shippingAddressStreet":"string","shippingAddressCity":"string","shippingAddressState":"string","shippingAddressCountry":"string","shippingAddressPostalCode":"string","description":"string","campaignId":"string","campaignName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","assignedUserId":"string","assignedUserName":"string","targetListId":"string","targetListName":"string","originalLeadId":"string","originalLeadName":"string","targetListIsOptedOut":"bool","channelId":"string","channelName":"string","emailAddressIsOptedOut":"bool","billingAddressMap":"string","shippingAddressMap":"string","ownerUserId":"string","ownerUserName":"string"}
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'}
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'}

Activities

Get list of Activitiess
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": [[]]}

AssociatedProduct

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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}
Create AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}
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
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}
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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}]}
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
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
Export 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
{'id': 'string'}
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'}
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'}
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'
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'
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'
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'
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'
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
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"associationId":"string","associationName":"string","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","mainProductId":"string","mainProductName":"string","relatedProductId":"string","relatedProductName":"string","mainProductImage":"string","bothDirections":"bool","backwardAssociationId":"string","backwardAssociationName":"string","relatedProductImage":"string"}
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'}
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 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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","backwardAssociationId":"string","backwardAssociationName":"string"}
Create Association
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","backwardAssociationId":"string","backwardAssociationName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","backwardAssociationId":"string","backwardAssociationName":"string"}
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
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","backwardAssociationId":"string","backwardAssociationName":"string"}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","backwardAssociationId":"string","backwardAssociationName":"string"}
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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","nameDeDe":"string","nameEnUs":"string","description":"string","descriptionDeDe":"string","descriptionEnUs":"string","isActive":"bool","createdAt":"string","modifiedAt":"string","createdById":"string","createdByName":"string","modifiedById":"string","modifiedByName":"string","ownerUserId":"string","ownerUserName":"string","assignedUserId":"string","assignedUserName":"string","backwardAssociationId":"string","backwardAssociationName":"string"}]}
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
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
Export 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
{'id': 'string'}
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'}
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'}
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'
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'
Follow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json