Retrieve a published policy

GET

/v1/p/policies/{id}

const url = 'http://api.disclosebot.localdev:3000/v1/p/policies/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Unauthenticated. The payload the policy embed renders (the hosted policy page inlines the same document). An unpublished policy is not found. While paid plans are on sale, a plan that does not include embeds gets the upgrade_required error; the embed then shows a card linking to the hosted page (public_url in the error meta).

Parameters

Path Parameters

required

string

Policy id or shortcode

Responses

200

Successful

application/vnd.api+json

object

data

required

object

required

string

type

required

string

Allowed values: policy

attributes

required

object

name

required

string

shortcode

required

string

short_description

string

nullable

point_of_contact

string

nullable

cvd_timeline

integer

nullable

safe_harbor

string

nullable

offers_bounty

boolean

nullable

offers_swag

boolean

nullable

hall_of_fame

boolean

nullable

contact_url

string

nullable

securitytxt_url

string

nullable

public_disclosure

boolean

nullable

safe_harbor_attested_on

string

nullable

disclosure_attested_on

string

nullable

rewards_attested_on

string

nullable

launch_date

string

nullable

policy_html

required

Rendered, sanitized HTML of the policy

string

public_url

required

The hosted policy page

string

attribution

required

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

boolean

template

object

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

created_at

string

updated_at

string

relationships

object

included

Array<object>

object

required

string

type

required

string

Allowed values: organization

attributes

required

object

name

string

Example

{
  "data": {
    "type": "policy"
  },
  "included": [
    {
      "type": "organization"
    }
  ]
}

403

The plan does not include embeds

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