Skip to content

Get Send Log

GET
/v1/app-communications/logs/{log_id}

Return a single outbound communication log for the authenticated tenant.

log_id
required
Log Id
string

Successful Response

Response[SendLogRead]
object
data
required
SendLogRead
object
id
required
Id
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
message_id
required
Message Id
string format: uuid
workos_org_id
required
Workos Org Id
string
channel
required
CommunicationChannel
string
Allowed values: email
category
required
CommunicationCategory
string
Allowed values: billing product support task auth
message_type
required
Message Type
string
recipient_email
required
Recipient Email
string format: email
recipient_name
Any of:
string
status
required
DeliveryStatus
string
Allowed values: pending sent delivered opened clicked bounced complained failed
resend_message_id
Any of:
string
error
Any of:
string
triggered_by
Any of:
string
sent_at
Any of:
string format: date-time
delivered_at
Any of:
string format: date-time
opened_at
Any of:
string format: date-time
clicked_at
Any of:
string format: date-time
bounced_at
Any of:
string format: date-time
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object