Retrieve a published portal

GET

/v1/p/portals/{id}

const url = 'http://api.disclosebot.localdev:3000/v1/p/portals/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/portals/example

Unauthenticated. The same payload the hosted portal page and the portal embed render, with each group’s briefs inline. An unpublished portal is not found.

Parameters

Path Parameters

required

string

Portal id or shortcode

Responses

200

Successful

application/vnd.api+json

object

data

required

object

required

string

type

required

string

Allowed values: portal

attributes

required

object

name

required

string

shortcode

required

string

short_description

string

nullable

description

string

nullable

welcome_message

string

nullable

public_url

required

The hosted portal 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

groups

required

Array<object>

object

string

name

string

description

string

nullable

position

integer

nullable

briefs

Array<object>

object

required

string

shortcode

required

string

name

required

string

short_description

string

nullable

description

string

nullable

description_html

string

nullable

rules_of_engagement

string

nullable

rules_of_engagement_html

string

nullable

submission_policy

string

nullable

submission_policy_html

string

nullable

assets

Array<object>

object

string

kind

string

value

string

short_description

string

nullable

in_scope_assets

Array<object>

object

string

kind

string

value

string

short_description

string

nullable

out_of_scope_assets

Array<object>

object

string

kind

string

value

string

short_description

string

nullable

policies

Array<object>

object

relationships

object

included

Array<object>

object

required

string

type

required

string

Allowed values: organization

attributes

required

object

name

string

Example

{
  "data": {
    "type": "portal"
  },
  "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