GetChannel

Retrieve a channel.

GET /api/v3/channels/{channelId}

GetChannel

cURL

curl --request GET \
  --url https://api.siftstack.com/api/v3/channels/{channelId} \
  --header 'Authorization: Bearer <token>'

200

{
  "channel": {
    "channelId": "<string>",
    "name": "<string>",
    "assetId": "<string>",
    "description": "<string>",
    "unitId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z",
          "isArchived": true
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "relationValue": {
          "resourceType": "<string>",
          "resourceId": "<string>"
        },
        "archivedDate": "2023-11-07T05:31:56Z",
        "isArchived": true
      }
    ],
    "enumTypes": [
      {
        "name": "<string>",
        "key": 123,
        "isSigned": true
      }
    ],
    "bitFieldElements": [
      {
        "name": "<string>",
        "index": 123,
        "bitCount": 123
      }
    ],
    "displayDescription": "<string>",
    "displayUnitId": "<string>",
    "active": true
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

channelId · string · required

Response

200

application/json

A successful response.

The response of a call to ChannelService_GetChannel.

channel · object · required

Show child attributes