Channels

Get a channel by channel id

This method requires the Channels:Get permission to be associated with your role.

GET

/fm/channels/{channel_id}

curl --request GET \
  --url https://api.catch-e.com/fm/channels/{channel_id} \
  --header 'Authorization: <api-key>'

{
  "_links": {
    "channel_group": {
      "href": "https://api.catch-e.com/fm/channel/groups/100000"
    },
    "company": {
      "href": "https://api.catch-e.com/gb/companies/1"
    },
    "self": {
      "href": "https://api.catch-e.com/fm/channels/100000"
    }
  },
  "bank_account_name": "ABC Bank",
  "bank_account_number": 123456789,
  "bank_bsb": "987-654",
  "channel": "ABC Pty Ltd",
  "channel_code": "ABC",
  "channel_group_id": "100000",
  "channel_id": "100000",
  "company_id": "1",
  "status_flag": "active"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

channel_idstringrequired

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]{0,9}$

Response

Success

_linksobject

Show child attributes

bank_account_namestring

Bank Name

Example: ABC Bank

bank_account_numberstring

Bank Account number

Example: 123456789

bank_bsbstring

Bank BSB

Example: 987-654

channelstring

Example: ABC Pty Ltd

channel_codestring

Example: ABC

channel_group_idstring

Example: 100000

channel_idstring

Example: 100000

company_idstring

Example: 1

status_flagenum<string>default:active

Status flag

Available options: active, inactive

Example: active

Still need help? Ask the team