List all bundles #

Used to get an overview of all your mailings. You can also filter the list based on tags that you specified when sending.

Quick start #

💻
Quick start (cURL)
Copy to clipboard
curl -X GET "https://api.ip1.net/v3/bundles" \
  -H "Authorization: Bearer API_TOKEN"

Call #

Endpoint: /bundles

Methodology: GET

Example of call data #

📄
Anropsdata (URL)
Copy to clipboard
https://api.ip1.net/v3/bundles?tag=kampanj-vår

Fields for call data #

Field nameDescription of the projectRequiredTypeExample
tagFilter the list to show only bundles with a specific tag.No, it is not.string"Spring campaign"

Responsibility #

Example of response data #

📋
Responsdata (JSON)
Copy to clipboard
[
  {
    "id": "65eb3d14f1234567890abcdef",
    "brand": "min-butik-ab",
    "agent": "kundservice",
    "content": "Hej! Glöm inte vår rea imorgon.",
    "uniqueId": "sale-notice-001",
    "created": "2026-03-09T10:00:00Z",
    "tags": ["kampanj-vår"]
  }
]

Response data fields #

Field nameDescription of the projectTypeExample
idUnique ID for the bundle.string"65eb3d14f1234567890abcdef"
brandWhich brand does the shipment belong to?.string”my-store-ab”
agentWhich agent sent the message.string”customer service”
contentThe message's text content.string”Hi! Don't forget...”
uniqueIdYour own unique ID for the mailing.string”sale-notice-001”
createdTimestamp when the bundle was created.DateTime”03-09-2026 10:00:00”
tagsList of tags associated with the shipment.Array[”campaign-spring”]

Get a specific bundle #

Used when you want to see detailed information about a specific shipment by using its unique ID.

Quick start #

💻
Quick start (cURL)
Copy to clipboard
curl -X GET https://api.ip1.net/v3/bundles/65eb3d14f1234567890abcdef \
  -H "Authorization: Bearer API_TOKEN"

Call #

Endpoint /bundles/{bundle}

Methodology: GET

Example of call data #

📋
Anropsdata (URL)
Copy to clipboard
https://api.ip1.net/v3/bundles/65eb3d14f1234567890abcdef

Fields for call data #

Field nameDescription of the projectRequiredTypeExample
bundleThe unique ID (from previous response) of the bundle you want to retrieve.YesParam Path65eb3d14f1234567890abcdef

Responsibility #

Returns a single bundle object.

Example of response data #

📋
Responsdata (JSON)
Copy to clipboard
Hello! Here is your delivery confirmation.

Fields for response data #

Field nameDescription of the projectTypeExample
idUnique ID for the bundle.string"65eb3d14f1234567890abcdef"
brandWhich brand does the shipment belong to?.string”my-store-ab”
agentWhich agent sent the message.string”customer service”
contentThe message's text content.string”Hi! Don't forget...”
uniqueIdYour own unique ID for the mailing.string”sale-notice-001”
createdTimestamp when the bundle was created.DateTime”03-09-2026 10:00:00”