Get entity README

GET

/entities/{id}/readme

const url = 'https://shoehorn.example.com/api/v1/entities/example/readme';
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 https://shoehorn.example.com/api/v1/entities/example/readme

Parameters

Path Parameters

required

string

Responses

200

README content

application/json

object

content

string

format

string

Allowed values: markdown html

Example

{
  "format": "markdown"
}