List channels
GET
/v1/channels
const url = 'http://api.disclosebot.localdev:3000/v1/channels';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 \ --header 'Authorization: Bearer <token>'Channels of the organisation, filterable with ransack predicates and paginated. Add include=briefs,workflow.versions to embed the related records.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” page[number]
integer
page[size]
integer
q[name_cont]
string
Name contains
q[enabled_at_null]
boolean
True for disabled channels, false for enabled
q[s]
string
Sort, e.g. “created_at desc”
Responses
Section titled “ Responses ”Filtered by enabled state, paginated
Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
type
required
string
attributes
required
object
name
required
string
short_description
string
enabled
required
boolean
enabled_at
string format: date-time
prefilter_query
The custom pre-filter; null when the pre-filter references a saved search or there is none
object
q
object
key
additional properties
One of:
string
Array<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
running_version_number
integer
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" } ]}Unauthorized
Channels not available for the account