Get channel

Get a single channel by ID

GET/channels/{channelId}

Authorization

AuthorizationBearer token · headerrequired

Organization API key (modem_…).

Path parameters

channelIdstring<uuid>required

Responses

200

channelNamestringrequired

Human-readable name of the channel.

contextstring | nullrequired

User-provided context about the channel's purpose, used by the ingest pipeline's LLM classification and priority-scoring steps.

Show properties

Any of:

string

string

null

null

createdAtstring<date-time>required

ISO 8601 timestamp of channel creation

descriptionstring | nullrequired

Optional description of the channel.

Show properties

Any of:

string

string

null

null

idstring<uuid>required

Show properties

Any of:

string<uuid>

string<uuid>

string<uuid>

string<uuid>

isConnectedbooleanrequired

Whether the source server/workspace is currently connected (bot has not left)

lastSeenAtstring<date-time> | nullrequired

ISO 8601 timestamp of the most recent message in this channel, or null if no messages

Show properties

Any of:

string<date-time>

string<date-time>

null

null

messageCountintegerrequired

Total number of messages in this channel

min 0

serverNamestringrequired

Human-readable name of the server/workspace.

sourceChannelIdstringrequired

Channel identifier in the source system.

sourceNamestringrequired

Source system for the channel.

matches ^[a-z0-9]+(?:-[a-z0-9]+)*$

sourceServerIdstringrequired

Identifier of the server/workspace in the source system.

updatedAtstring<date-time>required

ISO 8601 timestamp of last channel update

400

Invalid request (validation failed).

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

401

Missing or invalid API key.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

403

The API key does not have access to this resource.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

404

The requested resource was not found.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

429

Rate limit exceeded.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

500

Internal server error.

codestringrequired

Machine-readable error code, e.g. NOT_FOUND.

dataany

Optional structured error details.

definedbooleanrequired

True if the error was declared in the procedure contract.

messagestringrequired

Human-readable error message.

statusintegerrequired

HTTP status code.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

channelIdpath*

Request

curl -X GET 'https://api.modem.dev/v1/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.modem.dev/v1/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.modem.dev/v1/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "channelName": "string",
  "context": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isConnected": true,
  "lastSeenAt": "2019-08-24T14:15:22Z",
  "messageCount": 0,
  "serverName": "string",
  "sourceChannelId": "string",
  "sourceName": "string",
  "sourceServerId": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}

{
  "code": "NOT_FOUND",
  "data": null,
  "defined": true,
  "message": "string",
  "status": 404
}