Folders
Update a folder's access controls
An actor triggers this event when they change the rules that control access to a folder. There can be multiple changes in a single update.
typestringDefault value: UPDATE_FOLDER_ACCESS_CONTROLS
Available values: The only valid value is UPDATE_FOLDER_ACCESS_CONTROLS.
access_control_changesUpdateFolderAccessControlChange[]A change to the rules that control the access to the folder.
The owner of the folder changed. For example, when a user left the team, or when the folder
moved into or out of a team space. old_owner or new_owner might be omitted if the folder
doesn't have a user owner. For example, when a folder is owned by a team inside a team space.
typestringDefault value: UPDATE_FOLDER_OWNER
Available values: The only valid value is UPDATE_FOLDER_OWNER.
old_ownerAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
new_ownerAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
A user granted another user access to the folder.
typestringDefault value: GRANT_USER_FOLDER_ACCESS
Available values: The only valid value is GRANT_USER_FOLDER_ACCESS.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
userAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
A user revoked another user's access to the folder.
typestringDefault value: REVOKE_USER_FOLDER_ACCESS
Available values: The only valid value is REVOKE_USER_FOLDER_ACCESS.
userAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
A user changed another user's access to the folder.
typestringDefault value: UPDATE_USER_FOLDER_ACCESS
Available values: The only valid value is UPDATE_USER_FOLDER_ACCESS.
old_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
new_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
userAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
A user granted a group(opens in a new tab or window) access to the folder.
typestringDefault value: GRANT_GROUP_FOLDER_ACCESS
Available values: The only valid value is GRANT_GROUP_FOLDER_ACCESS.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
groupAuditLogGroupA Canva group.
idstringThe group ID.
display_namestringThe display name of the group.
A user revoked a group's(opens in a new tab or window) access to the folder.
typestringDefault value: REVOKE_GROUP_FOLDER_ACCESS
Available values: The only valid value is REVOKE_GROUP_FOLDER_ACCESS.
groupAuditLogGroupA Canva group.
idstringThe group ID.
display_namestringThe display name of the group.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
A user changed a group's(opens in a new tab or window) access to the folder.
typestringDefault value: UPDATE_GROUP_FOLDER_ACCESS
Available values: The only valid value is UPDATE_GROUP_FOLDER_ACCESS.
old_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
new_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
groupAuditLogGroupA Canva group.
idstringThe group ID.
display_namestringThe display name of the group.
A user granted a team(opens in a new tab or window) access to the folder.
typestringDefault value: GRANT_TEAM_FOLDER_ACCESS
Available values: The only valid value is GRANT_TEAM_FOLDER_ACCESS.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
teamAuditLogTeamA Canva team.
idstringThe team ID.
display_namestringThe display name of the team.
For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
A user revoked a team's(opens in a new tab or window) access to the folder.
typestringDefault value: REVOKE_TEAM_FOLDER_ACCESS
Available values: The only valid value is REVOKE_TEAM_FOLDER_ACCESS.
teamAuditLogTeamA Canva team.
idstringThe team ID.
display_namestringThe display name of the team.
For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
A user changed a team's(opens in a new tab or window) access to the folder.
typestringDefault value: UPDATE_TEAM_FOLDER_ACCESS
Available values: The only valid value is UPDATE_TEAM_FOLDER_ACCESS.
old_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
new_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
teamAuditLogTeamA Canva team.
idstringThe team ID.
display_namestringThe display name of the team.
For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
A user granted an organization access to the folder.
typestringDefault value: GRANT_ORGANIZATION_FOLDER_ACCESS
Available values: The only valid value is GRANT_ORGANIZATION_FOLDER_ACCESS.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
organizationAuditLogOrganizationA Canva organization.
idstringThe organization ID.
display_namestringThe display name of the organization.
For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.
A user revoked an organization's access to the folder.
typestringDefault value: REVOKE_ORGANIZATION_FOLDER_ACCESS
Available values: The only valid value is REVOKE_ORGANIZATION_FOLDER_ACCESS.
organizationAuditLogOrganizationA Canva organization.
idstringThe organization ID.
display_namestringThe display name of the organization.
For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.
accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
A user changed an organization's access to the folder.
typestringDefault value: UPDATE_ORGANIZATION_FOLDER_ACCESS
Available values: The only valid value is UPDATE_ORGANIZATION_FOLDER_ACCESS.
old_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
new_accessFolderAccessLevelWhether the folder's content can be viewed, edited, organized or managed.
readbooleanWhether read access has been provided (true) or denied (false).
writebooleanWhether write access has been provided (true) or denied (false).
For a folder in a team space, this only includes adding and editing content. Removing
and moving content requires organize.
organizebooleanWhether access to organize content in the folder has been provided (true) or denied
(false). Only applies to folders in a team space.
managebooleanWhether access to administer the folder has been provided (true) or denied (false).
Can only be granted via a team space.
organizationAuditLogOrganizationA Canva organization.
idstringThe organization ID.
display_namestringThe display name of the organization.
For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UPDATE_FOLDER_ACCESS_CONTROLS","access_control_changes": [{"type": "UPDATE_FOLDER_OWNER","old_owner": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"},"new_owner": {"id": "UXqwwoQDSbb","display_name": "Ash Doe","email": "ash.doe@example.com"}},{"type": "GRANT_USER_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"user": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"}},{"type": "REVOKE_USER_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"user": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"}},{"type": "UPDATE_USER_FOLDER_ACCESS","old_access": {"read": true,"write": false},"new_access": {"read": true,"write": true},"user": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"}},{"type": "GRANT_GROUP_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"group": {"id": "GJViWaMsqhL","display_name": "Marketing Group"}},{"type": "REVOKE_GROUP_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"group": {"id": "GJViWaMsqhL","display_name": "Marketing Group"}},{"type": "UPDATE_GROUP_FOLDER_ACCESS","old_access": {"read": true,"write": false},"new_access": {"read": true,"write": true},"group": "GADkBZ48E04"},{"type": "GRANT_TEAM_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"team": {"id": "BXeFatjDhdR","display_name": "Acme Team"}},{"type": "REVOKE_TEAM_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"team": {"id": "BXeFatjDhdR","display_name": "Acme Team"}},{"type": "UPDATE_TEAM_FOLDER_ACCESS","old_access": {"read": true,"write": false},"new_access": {"read": true,"write": true},"team": {"id": "BXeFatjDhdR","display_name": "Acme Corporation"}},{"type": "GRANT_ORGANIZATION_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"organization": {"id": "OXtgecafZvh","display_name": "Acme Corporation"}},{"type": "REVOKE_ORGANIZATION_FOLDER_ACCESS","access": {"read": true,"write": true,"organize": true,"manage": true},"organization": {"id": "OXtgecafZvh","display_name": "Acme Corporation"}},{"type": "UPDATE_ORGANIZATION_FOLDER_ACCESS","old_access": {"read": true,"write": false},"new_access": {"read": true,"write": true},"organization": {"id": "OXtgecafZvh"}}]},"outcome": ...,"context": ...}
Add an item to a folder
An actor triggers this event when they add an item to a folder.
typestringDefault value: ADD_ITEM_TO_FOLDER
Available values: The only valid value is ADD_ITEM_TO_FOLDER.
itemFolderItemAn item in a folder, such as a design.
owner is omitted when the item is owned by a team space, as team spaces have no user owner.
item_typestringThe type of item.
Available values:
FOLDER: A folder.DESIGN: A design.IMAGE: An image.VIDEO: A video.AUDIO: An audio.TEMPLATE: A template.FILE: A file.
idstringThe item ID.
teamAuditLogTeamA Canva team.
idstringThe team ID.
display_namestringThe display name of the team.
For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
ownerAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
display_namestringThe display name of the item. Rarely, it may be omitted for technical reasons.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "ADD_ITEM_TO_FOLDER","item": {"item_type": "DESIGN","id": "DXWEBartcNg","team": {"id": "BXeFatjDhdR","display_name": "Acme Team"},"owner": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"},"display_name": "My awesome design"}},"outcome": ...,"context": ...}
Remove an item from a folder
An actor triggers this event when they remove an item from a folder.
typestringDefault value: REMOVE_ITEM_FROM_FOLDER
Available values: The only valid value is REMOVE_ITEM_FROM_FOLDER.
itemFolderItemAn item in a folder, such as a design.
owner is omitted when the item is owned by a team space, as team spaces have no user owner.
item_typestringThe type of item.
Available values:
FOLDER: A folder.DESIGN: A design.IMAGE: An image.VIDEO: A video.AUDIO: An audio.TEMPLATE: A template.FILE: A file.
idstringThe item ID.
teamAuditLogTeamA Canva team.
idstringThe team ID.
display_namestringThe display name of the team.
For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
ownerAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
display_namestringThe display name of the item. Rarely, it may be omitted for technical reasons.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "REMOVE_ITEM_FROM_FOLDER","item": {"item_type": "DESIGN","id": "DXWEBartcNg","team": {"id": "BXeFatjDhdR","display_name": "Acme Team"},"owner": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"},"display_name": "My awesome design"}},"outcome": ...,"context": ...}
Request access to a folder
An actor triggers this event when they request access to a folder.
This request is sent to the owner of the folder.
typestringDefault value: REQUEST_FOLDER_ACCESS
Available values: The only valid value is REQUEST_FOLDER_ACCESS.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "REQUEST_FOLDER_ACCESS"},"outcome": ...,"context": ...}
Grant access to a folder
An actor (typically the folder owner) triggers this event when they grant the requester access to their folder.
typestringDefault value: GRANT_FOLDER_ACCESS
Available values: The only valid value is GRANT_FOLDER_ACCESS.
requesterAuditLogUserA Canva user.
idstringThe user ID.
display_namestringThe display name of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
emailstringThe email address of the user.
For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
accessstringA user's access level for a folder.
Available values:
VIEW: The user can view the folder and its contents.EDIT: The user can view and edit the folder and its contents.ADMIN: The user can view, edit, and modify access to the folder and its contents.ORGANIZE: The user can view, edit, and organize the folder and its contents. This access level applies only to folders in a Team Space.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "GRANT_FOLDER_ACCESS","requester": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe","email": "jane.doe@example.com"},"access": "VIEW"},"outcome": ...,"context": ...}