The request retrieves all the messages that are ready. The response returns the message IDs that were created in the order they were created, starting with the first.

Use a GET method and the following URL:

{service_uri}/api/v1/messages?page={}view={view}

where:

{service_uri} is the URI of the service.
{page} is the number of pages that will be retrieved. This is explained in the Query parameters section in more detail.
{view} is the source of the messages that are returned.

For example:

curl --request GET \
     --url 'https://e-invoicing-message.vertexcloud.com/api/v1/messages?page=4&view=outbox' \
     --header 'accept: application/json'

Details

Type	Value
Endpoint	`/api/v1/messages`
Method	GET
API Reference Topic	List all messages

Query parameters

Parameter	Description
page	Zero-based index of the page to retrieve. The first page is 0, the second is 1, and so on.
view	Source of the messages that are returned. inbox messages are those available in your inbox and haven't yet been downloaded. outbox messages are those sent to and downloaded by the recipient. all includes both inbox and outbox messages. The following values are allowed: `inbox`, `outbox`, and `all`.

Response parameters

The following fields are returned for a successful request. All of these fields are required:

Field	Details	Description
`availableMessages`	int32	Count of available messages that match the specified query parameters.
`messages`	Array	An array that contains information about the message.
`message.charset`	String	The character set that the message is encoded in.
`message.documentTypeId`	String	Internal ID of the identified document type of the message. The internal ID that represents the Document Type ID.
`message.fileName`	String	Filename of the message.
`message.lastChanged`	Date-time	Timestamp of the message's last update, specified in ISO 8601 format.
`message.messageId`	UUID	The message's ID.
`message.messageSize`	int32	Size of the message (in megabytes).
`message.mimeType`	String	Identified the document type of the message.
`message.receivedAt`	Date-time	Timestamp of the message's receipt (in the ISO 8601 format).
`message.receiverName`	String	The recipient's name.
`message.receiverUuid`	UUID	ID of the recipient.
`message.reference`	String	Reference ID found within the message body.
`message.senderName`	String	Sender's name.
`message.senderUuid`	UUID	ID of the sender.
`message.status`	String	Status of the message.

Error parameters

The fields that are used to return error information are listed in the Error Fields Reference topic.

Example

Request

curl --request GET \
  --url 'https://e-invoicing-message.vertexcloud.com/api/v1/messages?page=ABCD1234&view=outbox' \
     --header 'accept: application/json'

Response

200

The following is a successful response, indicated by a 200 code:

{
  "availableMessages": 12,
  "messages": [
    {
      "charset": "UTF-8",
      "documentTypeId": "XML_4p1_ebInterface",
      "fileName": "70d4ec9d-33f9-46c1-94fc-93548dad7612.xml",
      "lastChanged": "2025-09-22T14:26Z",
      "messageId": "70d4ec9d-33f9-46c1-94fc-93548dad7612",
      "messageSize": 1212341,
      "mimeType": "XML",
      "receivedAt": "2025-09-22T14:25:03Z",
      "receiverName": "Test Receiver",
      "receiverUuid": "4ac1e432-f900-424f-92ab-edd501812342",
      "reference": "4711",
      "senderName": "Test Sender",
      "senderUuid": "45c2dae5-4235-45b0-98c2-c2342b10919f",
      "status": "PROCESSING"
    }
  ]
}