ListChannels

Retrieve channels using an optional filter.

GET /api/v3/channels

ListChannels

cURL

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

200

{
  "channels": [
    {
      "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
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

pageSize · integer<int64>

The maximum number of channels to return. The service may return fewer than this value. If unspecified, at most 50 channels will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000. Optional.

pageToken · string

A page token, received from a previous ListChannels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListChannels must match the call that provided the page token. Optional.

filter · string

A Common Expression Language (CEL) filter string. Available fields to filter by are channel_id, asset_id, name, description run_id, run_name, run_client_key, created_date, modified_date, created_by_user_id, and modified_by_user_id. For further information about how to use CELs, please refer to this guide.

orderBy · string

How to order the retrieved channels. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date and modified_date, active. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

Response

200

application/json

A successful response.

The result of a call to ChannelService_ListChannels.

channels · object[]

Show child attributes

nextPageToken · string