Show directory listing

GET

/v1/directory_listings/{id}

const url = 'http://api.disclosebot.localdev:3000/v1/directory_listings/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/directory_listings/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

required

string

Responses

200

Successful

application/vnd.api+json

object

data

required

object

required

string format: uuid

type

required

string

Allowed values: directory_listing

attributes

required

object

visible

required

boolean

customized

required

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

relationships

object

directory

object

data

object

required

string format: uuid

type

required

string

Allowed values: directory

organization

object

data

object

required

string format: uuid

type

required

string

Allowed values: organization

Example

{
  "data": {
    "type": "directory_listing",
    "relationships": {
      "directory": {
        "data": {
          "type": "directory"
        }
      },
      "organization": {
        "data": {
          "type": "organization"
        }
      }
    }
  }
}

401

Unauthorized

404

Not found