Get Email Campaigns

Gets email campaigns.

The Email channel handles transactional and campaign email — templates, footers, signatures, campaigns, and provider integrations.

This endpoint returns the email campaigns available in your project.

Gets email campaigns

get

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

DatabaseIntegrationIdstring · nullableOptional

Optional. When omitted, the project's default database integration is used (resolved server-side from the project state).

CampaignIdstring · nullableOptional

Optional: return only the campaign with this id.

EmailAddressstring · nullableOptional

Optional: only campaigns that targeted this email address.

TemplateIdstring · nullableOptional

Optional: only campaigns built on this email template id.

Frominteger · int64 · nullableOptional

Optional lower bound for the campaign time, unix timestamp in seconds (UTC).

Tointeger · int64 · nullableOptional

Optional upper bound for the campaign time, unix timestamp in seconds (UTC).

startingAfterstring · nullableOptional

Cursor token — fetch the page AFTER this item.

endingBeforestring · nullableOptional

Cursor token — fetch the page BEFORE this item.

pageSizeinteger · int32 · nullableOptional

Amount of records to return.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

get/{version}/notifications/email/campaigns

HTTPcURLJavaScriptPython

GET /{version}/notifications/email/campaigns HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "list": {
    "items": [],
    "hasMore": true,
    "hasPrevious": true,
    "startingAfter": "text",
    "endingBefore": "text"
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Notifications.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Email Campaigns in the SDK reference, with examples in every language.