Sharing

Read share settings

Current visibility, link permission, whether a link password is set, staged-publishing state, and embed settings. Scope: reports:read.

get/reports/{id}/share

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/reports/{id}/share
  • Auth: HTTP bearer

Response

Share settings.

idstring uuid required
visibility'private' | 'team' | 'registered' | 'public' | 'domain' required
public_permission'none' | 'view' | 'comment' | 'edit' required
allowed_email_domainsstring[]

Email domains allowed to view. Empty unless visibility is 'domain'.

password_setboolean required
show_approved_onlyboolean required
approved_revision_idstring uuid nullable
allowed_embed_originsstring[] required
embed_urlstring nullable required

/embed/{id}, or null when embedding is off.

embed_snippetstring nullable required

Markup to paste into the host page, or null when embedding is off. Renders only while the report is public, its link permission isn't none, and it has no share password.

updated_atstring date-time required
share_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.