Skip to content

Retrieving a list of Mailings

GET /mailings

Returns a list of Mailings sorted by the modificationDate property in descending order.

Request Parameters

Parameter Required In Description Constraints
isApproved no query Filters Mailings based on whether they are approved (true) or not (false) (do or do not have an approved Mailing Version). Parameters hasDraft and isApproved cannot simultaneously have the value false.
hasDraft no query Filters Mailings based on whether they have a draft Mailing Version (true) or not (false). Parameters hasDraft and isApproved cannot simultaneously have the value false.
id no query Returns Mailings for a list of comma-separated IDs. Must not exceed 50 IDs
pageSize no query Specifies the number of results per page. Default: 1000

Response Structure

Path Type Description
id String The ID of the Mailing
name String The name of the Mailing
creationDate String The date and time when the Mailing was created
modificationDate String The date and time when the Mailing was last modified
isApproved Boolean Indicates whether an approved version exists for this Mailing
hasDraft Boolean Indicates whether a draft version exists for this Mailing

Basic Example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/mailings' -i -X GET \
    -H 'Authorization: Basic <base64Encoded user:password>'

Response:

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

{
    "_embedded": {
        "inx:mailings": [
            {
                "id": "a9656ccc-15b3-4fe5-a1c7-800f0856d7a0",
                "name": "Example Mailing 1",
                "creationDate": "2023-04-12T08:53:13.982Z",
                "modificationDate": "2023-04-12T08:53:16.620Z",
                "isApproved": true,
                "hasDraft": false,
                "_links": {
                    "self": {
                        "href": "https://myka-1.my-api.inxmail.de/editor/mailing-editor/mailings/a9656ccc-15b3-4fe5-a1c7-800f0856d7a0"
                    },
                    "inx:mailing-editor": {
                        "href": "https://myka-1.my.inxmail.de/editor/integrations/mailings/a9656ccc-15b3-4fe5-a1c7-800f0856d7a0/edit"
                    }
                }
            },
            {
                "id": "0d8fe260-7b9f-43e0-9ba8-ac182846e570",
                "name": "Example Mailing 2",
                "creationDate": "2023-04-12T08:24:51.334Z",
                "modificationDate": "2023-04-12T08:25:03.534Z",
                "isApproved": true,
                "hasDraft": true,
                "_links": {
                    "self": {
                        "href": "https://myka-1.my-api.inxmail.de/editor/mailing-editor/mailings/0d8fe260-7b9f-43e0-9ba8-ac182846e570"
                    },
                    "inx:mailing-editor": {
                        "href": "https://myka-1.my.inxmail.de/editor/integrations/mailings/0d8fe260-7b9f-43e0-9ba8-ac182846e570/edit"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "https://myka-1.my-api.inxmail.de/editor/mailing-editor/mailings"
        },
        "curies": [
            {
                "href": "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
                "name": "inx",
                "templated": true
            }
        ]
    }
}