Appendix: Shared resources

Many resources, such as templates, template folders, sequence folders and contact groups, can be shared with other people. A shared resource has a shared object with up to three lists. An empty object, {}, means it isn't shared.

PropertyTypeDescription
shared.usersArrayPeople it is shared with individually.
shared.users[].userIdStringThe person's Mixmax user _id, if they have an account.
shared.users[].emailStringThe person's email, if they don't have a Mixmax account yet.
shared.users[].acceptedBooleanWhether they accepted the share. Until they do, they don't see the resource.
shared.users[].roleStringread-only or read-write.
shared.teamsArrayTeams it is shared with.
shared.teams[]._idStringThe team's _id.
shared.teams[].roleStringread-only or read-write.
shared.orgsArrayWorkspaces it is shared with, as a whole.
shared.orgs[]._idStringThe workspace's _id.
shared.orgs[].roleStringread-only or read-write.

Someone reached through more than one share gets the highest role among them. Workspace admins can also reach resources owned by members of their workspace, whatever shared says.

Psst... like working with APIs? Come join us!