API Reference

Fetch Mailbox

get
https://app.mailivery.io/api/v1/campaigns/

Retrieve the full details of a single mailbox (campaign) by its numeric ID. By default, the response returns the campaign's core fields; opt in to additional data via query params to also include owner details, SMTP/IMAP connection settings, and ramp-up state.

This endpoint retrieves the details of a specific mailbox/campaign, including the owner's details and connection details.

Path Params
integer
required

Campaign ID.

Query Params
boolean
Defaults to false

Requests additional details about the owner.

boolean
Defaults to false

Requests SMTP & IMAP details about the campaign.

boolean

Requests ramp-up details about the campaign.

Headers
string
required

Any unique string, timestamp, or UUID for logging.

string
required
Defaults to multipart/form-data

Request Content-Type

string
required
Defaults to application/json

Expected Type for response

Responses

Updated 15 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago