API ReferenceChannels
List all channels
Returns all channels in the current environment.
GET
/v1/channelsAuthorization
ApiKeyAuth AuthorizationBearer <token>
API key authentication. Keys are prefixed with environment:
npk_live_for productionnpk_test_for testing/staging
In: header
Query Parameters
cursor?string
Pagination cursor for next page
limit?integer
Maximum number of items to return
Default
20Range
1 <= value <= 100status?string
Filter by channel status
Value in
"active" | "paused" | "archived"Response Body
application/json
application/json
curl -X GET "https://api.npayload.com/v1/channels"{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"status": "active",
"schema": {},
"retentionDays": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"cursor": "string",
"hasMore": true
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}Was this page helpful?