The Murals Report API lists all murals created in your organization. Company admins can access the API using the API keys generated from their company dashboard. Use filter parameters to narrow the API results.

Note: Some attributes may not be returned if they do not contain a value.

List of attributes response:
muralId
Unique ID of the mural.
roomId
Unique ID of the room containing the mural.
workspaceId
Unique ID of the workspace containing the room.
ownerIdEmail
Comma-separated list of owners of the mural. Includes a unique member ID, followed by an email address.
creatorId
Unique ID of the user who created the mural.
creatorEmail
Email address of the user who created the mural.
dateCreated
Date when the mural was created.
deleted
Boolean. When true, the mural is deleted.
dateDeleted
Date when the mural was deleted.
deletedUserId
Unique ID of the user who deleted the mural.
deletedUserEmail
Email address of the user who deleted the mural.
archived
Boolean. When true, the mural is archived.
dateArchived
Date when the mural was archived.
shareLinkMemberPermission
Values denoting link permissions for members who are visiting. Set by the mural owner.
Types of link permissions include:
- Can edit: User can edit the mural.
- View only: User can view mural but cannot edit.
- Off: Visitor link is turned off and can no longer be generated.
shareLinkVisitorPermission
Values denoting link permissions for any users who are visiting (no sign-up required). Set by the mural owner.
Types of link permissions include:
- Can edit: User can edit the mural.
- View only: User can view mural but cannot edit.
- Off: Visitor link is turned off and can no longer be generated.
memberCount
Number of members in the mural.
guestCount
Number of guests in the mural.
Language
Authentication
Header