Attachment

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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
Create Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"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","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
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
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"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","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}]}
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
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 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
{'id': 'string'}
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'}
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'}
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'
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'
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'
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'
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'
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
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"name":"string","type":"string","size":"integer","parent":"string","related":"string","sourceId":"string","field":"string","createdAt":"string","createdById":"string","createdByName":"string","contents":"string","role":"string","storage":"string","storageFilePath":"string","global":"bool","assignedUserId":"string","assignedUserName":"string"}
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'}
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'}

AuthLogRecord

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
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"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"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
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'}
Create AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
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'
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 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"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}]}
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
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 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
{'id': 'string'}
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'}
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'
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'
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'
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
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"username":"string","portalId":"string","portalName":"string","userId":"string","userName":"string","authTokenId":"string","authTokenName":"string","ipAddress":"string","createdAt":"string","isDenied":"bool","denialReason":"string","requestTime":"float","requestUrl":"string","requestMethod":"string","authTokenIsActive":"string","assignedUserId":"string","assignedUserName":"string"}
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'}
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

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
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"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"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
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'}
Create AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Espo-Authorization HASH
Body
{"teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{"deleted":"bool","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
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'
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 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"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}
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","teamsIds":["string","string","..."],"teamsNames":{"teamId - string":"teamName - string"},"token":"string","hash":"string","userId":"string","userName":"string","portalId":"string","portalName":"string","ipAddress":"string","isActive":"bool","lastAccess":"string","createdAt":"string","modifiedAt":"string","assignedUserId":"string","assignedUserName":"string"}]}
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
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 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
{'id': 'string'}
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'}
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'
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