Skip to main content
List Channels
curl --request GET \
  --url https://integration.getmateo.com/api/v1/channel \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "random uuid",
    "created_at": "now()",
    "updated_at": "now()",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "email",
    "name": "<string>",
    "handle": "<string>",
    "status": "draft",
    "active": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Range
string

Limiting and Pagination

​
Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

​
id
string

Channel ID

​
created_at
string

Channel creation date

​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
type
string

Channel type

​
name
string

Name of channel

​
handle
string

Channel handle

​
status
string

Status of channel

​
active
string

Is channel active?

​
select
string

Filtering Columns

​
order
string

Ordering. Allowed Fields: name

​
offset
string

Limiting and Pagination

​
limit
string

Limiting and Pagination

Response

200 - application/json

OK

​
id
string<uuid>
default:random uuid

Channel ID

​
created_at
string<timestamp with time zone>
default:now()

Channel creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid>

Organisation ID

​
type
enum<string>

Channel type

Available options:
email,
sms,
whatsapp,
instagram,
facebook,
google_business_messaging,
postal
​
name
string<text> | null

Name of channel

​
handle
string<text> | null

Channel handle

​
status
enum<string>

Status of channel

Available options:
draft,
in-review,
rejected,
active,
inactive
​
active
boolean<boolean> | null

Is channel active?