API ReferenceMessages
List messages
Returns messages published to the channel.
GET
/v1/channels/{channelId}/messagesAuthorization
ApiKeyAuth AuthorizationBearer <token>
API key authentication. Keys are prefixed with environment:
npk_live_for productionnpk_test_for testing/staging
In: header
Path Parameters
channelId*string
Channel ID
Query Parameters
cursor?string
Pagination cursor for next page
limit?integer
Maximum number of items to return
Default
20Range
1 <= value <= 100since?string
Only return messages after this timestamp
Format
date-timeuntil?string
Only return messages before this timestamp
Format
date-timeResponse Body
application/json
application/json
application/json
curl -X GET "https://api.npayload.com/v1/channels/string/messages"{
"data": [
{
"id": "string",
"channelId": "string",
"eventType": "string",
"payload": {},
"metadata": {},
"publishedAt": "2019-08-24T14:15:22Z",
"deliveryStatus": "pending"
}
],
"pagination": {
"cursor": "string",
"hasMore": true
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}Was this page helpful?