Channels

Channels enable datasets to be categorised or grouped together. A single workspace can have multiple channels.

Objects

Channel

Path	JSON Type	Format	Description
`id`	`string`	Version 4 UUID	The channel ID
`creator`	`object`	`Member`	The channel creator
`workspace`	`object`	`Workspace`	The channel workspace
`created`	`string`	ISO 8601 timestamp	The channel created at timestamp
`lastModified`	`string`	ISO 8601 timestamp	The channel last modified timestamp
`name`	`string`		The channel name
`description`	`string`		The channel description
`picture`	`string`	URL	The channel picture metadata

{
  "id" : "fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6",
  "name" : "SITChannel",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "creator" : {
    "id" : "auth0|6a205ea86a76a69d8a3babcb",
    "name" : "sit@meltano.com",
    "handle" : "@sit1"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2026-07-13T16:04:51.120084",
  "lastModified" : "2026-07-13T16:04:51.120092",
  "description" : "SITChannel",
  "picture" : "https://s.gravatar.com/avatar/cfaaad6e600823b9bc58225842b3a686?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsi.png",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "datasets" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/subscriptions"
    },
    "update channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "delete channel" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "add workspace-scope" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/scope/workspace"
    }
  }
}

Requests

Initialise a channel

POST /api/channels/{channel-id}

Initialise a channel.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{ }'

import requests

url = "https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels"

data = { }
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

Channel with HAL links.

{
  "id" : "c77e8492-a274-40e0-8668-14673025e4d6",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "created" : "2026-07-13T16:04:57.484369736",
  "lastModified" : "2026-07-13T16:04:57.484375978",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "create channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    }
  }
}

View a channel

GET /api/channels/{channel-id}

Returns the channel {channel-id}.

Prerequisites

Channel {channel-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6' -i -X GET

import requests

url = "https://staging.meltano.com:443/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Channel with HAL links.

{
  "id" : "fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6",
  "name" : "SITChannel",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "creator" : {
    "id" : "auth0|6a205ea86a76a69d8a3babcb",
    "name" : "sit@meltano.com",
    "handle" : "@sit1"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2026-07-13T16:04:51.120084",
  "lastModified" : "2026-07-13T16:04:51.120092",
  "description" : "SITChannel",
  "picture" : "https://s.gravatar.com/avatar/cfaaad6e600823b9bc58225842b3a686?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsi.png",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "datasets" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/subscriptions"
    },
    "update channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "delete channel" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "add workspace-scope" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/scope/workspace"
    }
  }
}

View a channel in a workspace

GET /api/workspaces/{workspace-id}/channels/{channel-id}

Returns a channel in the workspace {workspace-id}.

Prerequisites

Workspace {workspace-id} must exist
The user must be a member of the workspace {workspace-id}

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6' -i -X GET

import requests

url = "https://staging.meltano.com:443/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Channel with HAL links.

{
  "id" : "fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6",
  "name" : "SITChannel",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "creator" : {
    "id" : "auth0|6a205ea86a76a69d8a3babcb",
    "name" : "sit@meltano.com",
    "handle" : "@sit1"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2026-07-13T16:04:51.120084",
  "lastModified" : "2026-07-13T16:04:51.120092",
  "description" : "SITChannel",
  "picture" : "https://s.gravatar.com/avatar/cfaaad6e600823b9bc58225842b3a686?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsi.png",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "datasets" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/subscriptions"
    },
    "update channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "delete channel" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "add workspace-scope" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/scope/workspace"
    }
  }
}

View all channels in a workspace

GET /api/workspaces/{workspace-id}/channels/{channel-id}?type={type}&source={source}&containsDataset={datasetId}

Returns all channels in the workspace {workspace-id}.

Prerequisites

Workspace {workspace-id} must exist
The user must be a member of the workspace {workspace-id}

Query Parameters

Parameter	Required	Format	Default Value	Description
`type`	No	string	None	Return channels by types: `list` or `source`
`source`	No	string	None	Return channels by source: `profile` or `workspace`
`containsDataset`	No	string	None	Adds a `containsDataset` boolean field to all channels returning if it contains the dataset

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels' -i -X GET

import requests

url = "https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Channel collection with HAL links.

{
  "_embedded" : {
    "channels" : [ {
      "id" : "fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6",
      "name" : "SITChannel",
      "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
      "creator" : {
        "id" : "auth0|6a205ea86a76a69d8a3babcb",
        "name" : "sit@meltano.com",
        "handle" : "@sit1"
      },
      "scope" : "PROFILE",
      "type" : "SOURCE",
      "created" : "2026-07-13T16:04:51.120084",
      "lastModified" : "2026-07-13T16:04:51.120092",
      "description" : "SITChannel",
      "datasetCount" : 0,
      "containsDataset" : false,
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
        },
        "datasets" : {
          "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/datasets",
          "type" : "GET"
        },
        "add subscription" : {
          "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/subscriptions"
        },
        "update channel" : {
          "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
        },
        "delete channel" : {
          "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
        },
        "add workspace-scope" : {
          "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/scope/workspace"
        }
      }
    }, {
      "id" : "9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b",
      "name" : "SITChannelTwo",
      "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
      "creator" : {
        "id" : "auth0|6a205ea86a76a69d8a3babcb",
        "name" : "sit@meltano.com",
        "handle" : "@sit1"
      },
      "scope" : "PROFILE",
      "type" : "SOURCE",
      "created" : "2026-07-13T16:04:51.238963",
      "lastModified" : "2026-07-13T16:04:51.23897",
      "description" : "SITChannelTwo",
      "datasetCount" : 0,
      "containsDataset" : false,
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/channels/9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b"
        },
        "datasets" : {
          "href" : "https://staging.meltano.com/api/channels/9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b/datasets",
          "type" : "GET"
        },
        "add subscription" : {
          "href" : "https://staging.meltano.com/api/channels/9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b/subscriptions"
        },
        "update channel" : {
          "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b"
        },
        "delete channel" : {
          "href" : "https://staging.meltano.com/api/channels/9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b"
        },
        "add workspace-scope" : {
          "href" : "https://staging.meltano.com/api/channels/9b6ebdc5-2e52-4f22-88e5-52989cdb4c1b/scope/workspace"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels?page=0&size=10&sort=name,asc"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Create or Update a channel in a workspace

PUT /api/workspaces/{workspace-id}/channels/{channel-id}

Creates or Updates a channel in the workspace {workspace-id}.

This endpoint takes a {channel-id} (UUID) and based on the supplied value and the channels that already exist in the workspace, will update or create a channel accordingly.

Prerequisites

Workspace {workspace-id} must exist
The user must be a admin in the workspace {workspace-id}

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SITChannel",
  "description" : "SITChannel"
}'

import requests

url = "https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"

data = {
  "name" : "SITChannel",
  "description" : "SITChannel"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK / 201 Created

Channel with HAL links.

{
  "id" : "fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6",
  "name" : "SITChannel",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "creator" : {
    "id" : "auth0|6a205ea86a76a69d8a3babcb",
    "name" : "sit@meltano.com",
    "handle" : "@sit1"
  },
  "scope" : "PROFILE",
  "type" : "SOURCE",
  "created" : "2026-07-13T16:04:51.120084141",
  "lastModified" : "2026-07-13T16:04:51.120092005",
  "description" : "SITChannel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "datasets" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/subscriptions"
    },
    "update channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "delete channel" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"
    },
    "add workspace-scope" : {
      "href" : "https://staging.meltano.com/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6/scope/workspace"
    }
  }
}

Delete a channel

DELETE /api/channels/{channel-id}

Delete a channel.

Prerequisites

The user must be a admin of the workspace the channel is in.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6' -i -X DELETE

import requests

url = "https://staging.meltano.com:443/api/channels/fa4069a8-dd93-4bf6-9c4c-8ea7167ee2e6"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.

View all channels in your workspace news

GET /api/channels/{channel-id}

Returns all channels in your news for the workspace.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/news/channels' -i -X GET

import requests

url = "https://staging.meltano.com:443/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/news/channels"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Channels in your workspace news.

{
  "_embedded" : {
    "channels" : [ {
      "id" : "422ef9d8-81b8-4f11-b7f5-7adf0af60546",
      "name" : "SITChannel",
      "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
      "creator" : {
        "id" : "auth0|6a205ea86a76a69d8a3babcb",
        "name" : "sit@meltano.com",
        "handle" : "@sit1"
      },
      "scope" : "WORKSPACE",
      "type" : "SOURCE",
      "created" : "2026-07-13T16:04:51.830696",
      "lastModified" : "2026-07-13T16:04:51.830703",
      "description" : "SITChannel",
      "picture" : "https://s.gravatar.com/avatar/cfaaad6e600823b9bc58225842b3a686?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fsi.png",
      "datasetCount" : 0,
      "containsDataset" : false,
      "_links" : {
        "search" : {
          "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/news?q=in%3ASITChannel"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels"
    }
  }
}

Add a dataset to a list channel

PUT /api/channels/{channel-id}/datasets/{dataset-id}

Adds a dataset to a channel with type list.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/datasets/9f572e77-566e-4660-b10f-4b157a5038b9' -i -X PUT \
    -H 'Content-Type: application/json'

import requests

url = "https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/datasets/9f572e77-566e-4660-b10f-4b157a5038b9"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers)

print(response.text.encode('utf8'))

Response

201 Created

No response body provided.

Remove a dataset from a list channel

DELETE /api/channels/{channel-id}/datasets/{dataset-id}

Removes a dataset from a channel with type list.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/datasets/9f572e77-566e-4660-b10f-4b157a5038b9' -i -X DELETE

import requests

url = "https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/datasets/9f572e77-566e-4660-b10f-4b157a5038b9"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.

Add workspace scope to a channel

PUT /api/channels/{channel-id}/scope/workspace

Add workspace scope to a channel.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/scope/workspace' -i -X PUT \
    -H 'Content-Type: application/json'

import requests

url = "https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/scope/workspace"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Channel with HAL links.

{
  "id" : "c77e8492-a274-40e0-8668-14673025e4d6",
  "name" : "mylist",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "creator" : {
    "id" : "auth0|6a205ea86a76a69d8a3babcb",
    "name" : "sit@meltano.com",
    "handle" : "@sit1"
  },
  "scope" : "WORKSPACE",
  "type" : "LIST",
  "created" : "2026-07-13T16:04:57.581378",
  "lastModified" : "2026-07-13T16:04:57.581385",
  "description" : "mylist channel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    },
    "datasets" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/subscriptions"
    },
    "update channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    },
    "delete channel" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    },
    "withdraw workspace-scope" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/scope/profile"
    }
  }
}

Withdraw workspace scope from a channel

PUT /api/channels/{channel-id}/scope/profile

Withdraw workspace scope from a channel.

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/scope/profile' -i -X PUT \
    -H 'Content-Type: application/json'

import requests

url = "https://staging.meltano.com:443/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/scope/profile"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Channel with HAL links.

{
  "id" : "c77e8492-a274-40e0-8668-14673025e4d6",
  "name" : "mylist",
  "workspaceId" : "221da4b6-eb68-4de2-9ec6-531295ba041d",
  "creator" : {
    "id" : "auth0|6a205ea86a76a69d8a3babcb",
    "name" : "sit@meltano.com",
    "handle" : "@sit1"
  },
  "scope" : "PROFILE",
  "type" : "LIST",
  "created" : "2026-07-13T16:04:57.581378",
  "lastModified" : "2026-07-13T16:04:57.581385",
  "description" : "mylist channel",
  "datasetCount" : 0,
  "containsDataset" : false,
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    },
    "datasets" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/datasets",
      "type" : "GET"
    },
    "add subscription" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/subscriptions"
    },
    "update channel" : {
      "href" : "https://staging.meltano.com/api/workspaces/221da4b6-eb68-4de2-9ec6-531295ba041d/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    },
    "delete channel" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6"
    },
    "add workspace-scope" : {
      "href" : "https://staging.meltano.com/api/channels/c77e8492-a274-40e0-8668-14673025e4d6/scope/workspace"
    }
  }
}

Objects​

Channel​

Requests​

Initialise a channel​

Examples

Response​

View a channel​

Prerequisites​

Examples

Response​

View a channel in a workspace​

Prerequisites​

Examples

Response​

View all channels in a workspace​

Prerequisites​

Query Parameters​

Examples

Response​

Create or Update a channel in a workspace​

Prerequisites​

Examples

Response​

Delete a channel​

Prerequisites​

Examples

Response​

View all channels in your workspace news​

Examples

Response​

Add a dataset to a list channel​

Examples

Response​

Remove a dataset from a list channel​

Examples

Response​

Add workspace scope to a channel​

Examples

Response​

Withdraw workspace scope from a channel​

Examples

Response​

See Also​

Objects

Channel

Requests

Initialise a channel

Response

View a channel

Prerequisites

Response

View a channel in a workspace

Prerequisites

Response

View all channels in a workspace

Prerequisites

Query Parameters

Response

Create or Update a channel in a workspace

Prerequisites

Response

Delete a channel

Prerequisites

Response

View all channels in your workspace news

Response

Add a dataset to a list channel

Response

Remove a dataset from a list channel

Response

Add workspace scope to a channel

Response

Withdraw workspace scope from a channel

Response

See Also