List Email Campaigns (lawmatics_list-email-campaigns)
List email campaigns from Lawmatics with optional pagination and sorting. Each row includes a `relationships` envelope of {id,type} pointers to its audience and custom email template.
Tool Input
pageinteger— Page number (1-based)(> 0)
sortBystring— Column to sort by(enum: "id", "created_at", "updated_at")
sortOrderstring— Sort direction; defaults to descending server-side(enum: "asc", "desc")
Tool Output
emailCampaignsarrayrequired— Email campaigns on this page of results
[]object
idstringrequired— Composite campaign ID (e.g. "MarketingCampaign-1"); pass this to get/stats tools to chain reads
namestringrequired— Campaign name as shown in Lawmatics
statusnumberrequired— Integer status code for the campaign (e.g. 0, 1); value meanings are not documented
openRatenumbernullrequired— Email open rate for the campaign; null when not yet computed
sendCountnumbernullrequired— Number of emails sent for this campaign; null when not yet computed
sentAtstringnullrequired— When the campaign was sent, as an ISO 8601 timestamp; null if it has not been sent
startedProcessingAtstringnullrequired— When the campaign started processing, as an ISO 8601 timestamp; null if it has not started
campaignTypestringrequired— Campaign kind; observed values are "MarketingCampaign" and "RecurringCampaign" ("DateCampaign" is documented but unobserved in responses)
createdAtstringrequired— When the campaign was created, as an ISO 8601 timestamp
relationshipsobjectrequired— JSON:API relationship pointers to related records as {id,type} stubs. Not materialized — follow a pointer by calling that resource's own get tool (e.g. type 'custom_email' -> get-custom-email). PROVISIONAL: shape modeled from documentation, not yet live-confirmed.
2 fields
audienceobjectnullrequired— Audience this campaign targets (type 'audience') pointer; null when it has no audience
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference (e.g. "user", "contact", "prospect", "firm"); resolve it by calling that resource's own get/find tool — this pointer is not materialized
customEmailobjectnullrequired— Custom email template this campaign sends (type 'custom_email') pointer; null when unset
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— JSON:API record class of the reference (e.g. "user", "contact", "prospect", "firm"); resolve it by calling that resource's own get/find tool — this pointer is not materialized
paginationobjectnullrequired— Pagination metadata from the API response; null when the endpoint returns no meta envelope
totalPagesnumbernullrequired— Total number of pages available; null if not reported
limitPerPagenumbernullrequired— Maximum campaigns returned per page; null if not reported
totalEntriesnumbernullrequired— Total number of email campaigns across all pages; null if not reported
Related Tools