show brief

GET

/v1/briefs/{id}

const url = 'http://api.disclosebot.localdev:3000/v1/briefs/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/briefs/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

required

string

Responses

200

Successful

application/json

object

data

required

object

data

object

string

type

string

Allowed values: brief

attributes

object

name

string

short_description

string

shortcode

string

created_at

string format: date-time

updated_at

string format: date-time

in_scope_assets

Array<object>

object

string format: uuid

kind

string

value

string

short_description

string

nullable

out_of_scope_assets

Array<object>

object

string format: uuid

kind

string

value

string

short_description

string

nullable

relationships

object

organization

object

data

object

string format: uuid

Allowed values: organization

type

string

Example

{
  "data": {
    "data": {
      "type": "brief",
      "relationships": {
        "organization": {
          "data": {
            "id": "organization"
          }
        }
      }
    }
  }
}

401

Unauthorized

404

Brief not found