Communication Logs
Endpoints for Communication Logs
ReferenceView as Markdown
Endpoints for Communication Logs
GET/api/v1/communication-logs
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"communicationChannelCOMMUNICATION_CHANNELOptional"sms", "email"recipientstringOptionalstatusSENDGRID_MAIL_EVENTSOptional"scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"dateFromstring (date-time)OptionaldateTostring (date-time)Optionalitemsarray of MemberCommunicationActivitiesResponseDtoRequired14 fieldsitemscommunicationChannelCOMMUNICATION_CHANNELRequired when parent is presentField path: items[].communicationChannelcurlcurl https://api.subrite.no/api/v1/communication-logs \
--header 'Authorization: Bearer <token>'"sms", "email"statusSENDGRID_MAIL_EVENTSRequired when parent is presentField path: items[].status"scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"bounceClassificationstringField path: items[].bounceClassification"Invalid Address", "Technical", "Content", "Reputation", "Frequency or Volume Too High", "Mailbox Unavailable", "Unclassified"deliveredAtstring (date-time)Required when parent is presentField path: items[].deliveredAtfirstOpenedAtstring (date-time)Required when parent is presentField path: items[].firstOpenedAtmemberIdstringRequired when parent is presentField path: items[].memberIdlastUpdatedAtstring (date-time)Required when parent is presentField path: items[].lastUpdatedAtsubjectstringRequired when parent is presentField path: items[].subjectcreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtcommunicationIdnumberRequired when parent is presentField path: items[].communicationIdidnumberRequired when parent is presentField path: items[].idshowCommunicationDetailsbooleanRequired when parent is presentField path: items[].showCommunicationDetailsmessageIdstringField path: items[].messageIdrecipientstringField path: items[].recipientmetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}unauthorized
This response has no body.
forbiddenResource
messageCodestringRequiredmessagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}internalServerError
Same fields as Get all communication logs for tenant with filters (403).