Retrieve a published brief

GET

/v1/p/briefs/{id}

curl --request GET \
  --url http://api.disclosebot.localdev:3000/v1/p/briefs/example

Unauthenticated. The same payload the hosted brief page and the brief embed render. An unpublished brief is not found.

Parameters

Path Parameters

id

required

string

Brief id or shortcode

Responses

200

Successful

Media type application/vnd.api+json

object

data

required

object

id

required

string

type

required

string

Allowed values: brief

attributes

required

object

name

required

string

shortcode

required

string

short_description

string

nullable

description

Raw markdown

string

nullable

description_html

Rendered, sanitized HTML

string

nullable

rules_of_engagement

string

nullable

rules_of_engagement_html

string

nullable

submission_policy

string

nullable

submission_policy_html

string

nullable

faq

Array<object>

nullable

object

show_public_reports

boolean

nullable

public_url

required

The hosted brief page

string

attribution

required

Whether the widget shows the “Powered by” mark; false only when the plan includes white label

boolean

updated_at

string

branding

required

object

primary_color

string

secondary_color

string

accent_color

string

font_heading

string

font_body

string

logo_url

string

nullable

banner_url

string

nullable

google_fonts

Array<string>

brand_name

string

brand_url

string

in_scope_assets

required

Array<object>

object

id

string

kind

string

value

string

short_description

string

nullable

out_of_scope_assets

required

Array<object>

object

id

string

kind

string

value

string

short_description

string

nullable

relationships

object

included

Array<object>

object

Example

{
  "data": {
    "type": "brief"
  }
}

403

The plan does not include embeds

Media type application/vnd.api+json

object

errors

required

Array<object>

object

title

required

string

Allowed values: Upgrade required

detail

string

code

required

string

Allowed values: upgrade_required

status

required

string

Allowed values: 403

meta

required

object

feature

required

The entitlement feature key, e.g. automation

string

required_plan

The lowest-priced plan that includes the feature

string

nullable

organization_name

Public reads only: the organization the refused document belongs to

string

public_url

Public reads only: the hosted page the embed links to instead

string

Example

{
  "errors": [
    {
      "title": "Upgrade required",
      "code": "upgrade_required",
      "status": "403"
    }
  ]
}

404

Not published, or unknown