Show a channel

GET

/v1/channels/{id}

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

Authorizations

Bearer

Parameters

Path Parameters

required

string

Responses

200

Successful

application/json

object

data

required

object

required

string format: uuid

type

required

string

Allowed values: channel

attributes

required

object

name

required

string

short_description

string

nullable

enabled

required

boolean

enabled_at

string format: date-time

nullable

prefilter_query

The custom pre-filter; null when the pre-filter references a saved search or there is none

object

key

additional properties

One of:

string
Array<string>

string

results

object

key

additional properties

object

key

additional properties

string

prefilter_saved_search_id

The saved search the pre-filter reads; its query applies as it is now. Never set together with prefilter_query

string format: uuid

nullable

running_version_number

integer

nullable

steps_summary

Array<string>

created_at

required

string format: date-time

updated_at

required

string format: date-time

relationships

object

organization

object

workflow

object

prefilter_saved_search

object

Example

{
  "data": {
    "type": "channel"
  }
}

401

Unauthorized

404

Another organisation